Skip to content

Commit

Permalink
Move user profile status to stable and private (#90439) (#90491)
Browse files Browse the repository at this point in the history
This PR moves the user profile feature and associated APIs from
experimental to stable since higher level features built on top of it
are going to be GA. The feature and APIs are still kept private because
they are meant to internally support higher level features and we don't
expect them to be directly used by end-users.

This PR also moves the security domain feature to GA by removing the
beta label. Security domain requires user configuration to work so it is
not something internally controlled by stack and solutions.
  • Loading branch information
ywangd authored Sep 29, 2022
1 parent 76d8e86 commit e26a827
Show file tree
Hide file tree
Showing 16 changed files with 39 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html",
"description":"Creates or updates the user profile on behalf of another user."
},
"stability":"experimental",
"stability":"stable",
"visibility":"private",
"headers":{
"accept": [ "application/json"],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html",
"description":"Disables a user profile so it's not visible in user profile searches."
},
"stability":"experimental",
"stability":"stable",
"visibility":"private",
"headers":{
"accept": [ "application/json"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html",
"description":"Enables a user profile so it's visible in user profile searches."
},
"stability":"experimental",
"stability":"stable",
"visibility":"private",
"headers":{
"accept": [ "application/json"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html",
"description":"Retrieves user profiles for the given unique ID(s)."
},
"stability":"experimental",
"stability":"stable",
"visibility":"private",
"headers":{
"accept": [ "application/json"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges-user-profile.html",
"description":"Determines whether the users associated with the specified profile IDs have all the requested privileges."
},
"stability":"experimental",
"stability":"stable",
"visibility":"private",
"headers":{
"accept": [ "application/json"],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-suggest-user-profile.html",
"description":"Get suggestions for user profiles that match specified search criteria."
},
"stability":"experimental",
"stability":"stable",
"visibility":"private",
"headers":{
"accept": [ "application/json"],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html",
"description":"Update application specific data for the user profile of the given unique ID."
},
"stability":"experimental",
"stability":"stable",
"visibility":"private",
"headers":{
"accept": [ "application/json"],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
<titleabbrev>Activate user profile</titleabbrev>
++++

beta::[]
NOTE: The user profile feature is designed only for use by {kib} and
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
users and external applications should not call this API directly. Elastic reserves
the right to change or remove this feature in future releases without prior notice.

Creates or updates a user profile on behalf of another user.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
<titleabbrev>Disable user profile</titleabbrev>
++++

beta::[]
NOTE: The user profile feature is designed only for use by {kib} and
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
users and external applications should not call this API directly. Elastic reserves
the right to change or remove this feature in future releases without prior notice.

Disables a user profile so it's not visible in
<<security-api-suggest-user-profile,user profile searches>>.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
<titleabbrev>Enable user profile</titleabbrev>
++++

beta::[]
NOTE: The user profile feature is designed only for use by {kib} and
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
users and external applications should not call this API directly. Elastic reserves
the right to change or remove this feature in future releases without prior notice.

Enables a user profile so it's visible in
<<security-api-suggest-user-profile,user profile searches>>.
Expand Down
5 changes: 4 additions & 1 deletion x-pack/docs/en/rest-api/security/get-user-profile.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
<titleabbrev>Get user profiles</titleabbrev>
++++

beta::[]
NOTE: The user profile feature is designed only for use by {kib} and
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
users and external applications should not call this API directly. Elastic reserves
the right to change or remove this feature in future releases without prior notice.

Retrieves user profiles using a list of unique profile ID.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@
++++
<titleabbrev>Has privileges user profile</titleabbrev>
++++
[[security-api-has-privileges-user-profile]]

beta::[]
NOTE: The user profile feature is designed only for use by {kib} and
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
users and external applications should not call this API directly. Elastic reserves
the right to change or remove this feature in future releases without prior notice.

Determines whether the users associated with the specified <<user-profile, user profile>> IDs
have all the requested privileges.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
<titleabbrev>Suggest user profile</titleabbrev>
++++

beta::[]
NOTE: The user profile feature is designed only for use by {kib} and
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
users and external applications should not call this API directly. Elastic reserves
the right to change or remove this feature in future releases without prior notice.

Get suggestions for user profiles that match specified search criteria.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
<titleabbrev>Update user profile data</titleabbrev>
++++

beta::[]
NOTE: The user profile feature is designed only for use by {kib} and
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
users and external applications should not call this API directly. Elastic reserves
the right to change or remove this feature in future releases without prior notice.

Updates specific data for the user profile that's associated with the specified
unique ID.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
[[security-domain]]
=== Security domains

beta::[]

Security domains are a method of grouping multiple <<realms,realms>> under the
same domain so that the {stack} can recognize when a single user authenticates
with these realms. Users can authenticate with any of the realms in the domain
Expand Down
5 changes: 4 additions & 1 deletion x-pack/docs/en/security/authentication/user-profile.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
[[user-profile]]
=== User profiles

beta::[]
NOTE: The user profile feature is designed only for use by {kib} and
Elastic’s {observability}, {ents}, and {elastic-sec} solutions. Individual
users and external applications should not call this API directly. Elastic reserves
the right to change or remove this feature in future releases without prior notice.

Because the {stack} supports externally-managed users (such as users who
authenticate via SAML, or users stored in an LDAP directory), there's a
Expand Down

0 comments on commit e26a827

Please sign in to comment.