From e26a827a3306b8470f5a243fa2b1e778dc5bacf2 Mon Sep 17 00:00:00 2001 From: Yang Wang Date: Thu, 29 Sep 2022 12:31:36 +1000 Subject: [PATCH] Move user profile status to stable and private (#90439) (#90491) 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. --- .../rest-api-spec/api/security.activate_user_profile.json | 2 +- .../rest-api-spec/api/security.disable_user_profile.json | 2 +- .../rest-api-spec/api/security.enable_user_profile.json | 2 +- .../rest-api-spec/api/security.get_user_profile.json | 2 +- .../api/security.has_privileges_user_profile.json | 2 +- .../rest-api-spec/api/security.suggest_user_profiles.json | 2 +- .../api/security.update_user_profile_data.json | 2 +- .../en/rest-api/security/activate-user-profile.asciidoc | 5 ++++- .../docs/en/rest-api/security/disable-user-profile.asciidoc | 5 ++++- .../docs/en/rest-api/security/enable-user-profile.asciidoc | 5 ++++- x-pack/docs/en/rest-api/security/get-user-profile.asciidoc | 5 ++++- .../rest-api/security/has-privileges-user-profile.asciidoc | 6 ++++-- .../docs/en/rest-api/security/suggest-user-profile.asciidoc | 5 ++++- .../en/rest-api/security/update-user-profile-data.asciidoc | 5 ++++- .../en/security/authentication/security-domain.asciidoc | 2 -- .../docs/en/security/authentication/user-profile.asciidoc | 5 ++++- 16 files changed, 39 insertions(+), 18 deletions(-) diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.activate_user_profile.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.activate_user_profile.json index 02a8ef7144280..f03c79b876f80 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/security.activate_user_profile.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/security.activate_user_profile.json @@ -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"], diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.disable_user_profile.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.disable_user_profile.json index d5a60def7935f..77e8744f03056 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/security.disable_user_profile.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/security.disable_user_profile.json @@ -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"] diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.enable_user_profile.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.enable_user_profile.json index 861ac99ebc4fd..1b42ec401440f 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/security.enable_user_profile.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/security.enable_user_profile.json @@ -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"] diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.get_user_profile.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.get_user_profile.json index 0e14a802c260a..7ba652b9bd74b 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/security.get_user_profile.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/security.get_user_profile.json @@ -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"] diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.has_privileges_user_profile.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.has_privileges_user_profile.json index 168d320ddb4e3..8152170ac939a 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/security.has_privileges_user_profile.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/security.has_privileges_user_profile.json @@ -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"], diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.suggest_user_profiles.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.suggest_user_profiles.json index 7d0f4a7b15491..b52b2b74469e8 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/security.suggest_user_profiles.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/security.suggest_user_profiles.json @@ -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"], diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/security.update_user_profile_data.json b/rest-api-spec/src/main/resources/rest-api-spec/api/security.update_user_profile_data.json index ed92dd1b26a63..8324606a75b44 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/security.update_user_profile_data.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/security.update_user_profile_data.json @@ -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"], diff --git a/x-pack/docs/en/rest-api/security/activate-user-profile.asciidoc b/x-pack/docs/en/rest-api/security/activate-user-profile.asciidoc index 2a446391129d4..476477a5b5b72 100644 --- a/x-pack/docs/en/rest-api/security/activate-user-profile.asciidoc +++ b/x-pack/docs/en/rest-api/security/activate-user-profile.asciidoc @@ -5,7 +5,10 @@ Activate 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. Creates or updates a user profile on behalf of another user. diff --git a/x-pack/docs/en/rest-api/security/disable-user-profile.asciidoc b/x-pack/docs/en/rest-api/security/disable-user-profile.asciidoc index e9f4b54521aa0..a25b4a311aa81 100644 --- a/x-pack/docs/en/rest-api/security/disable-user-profile.asciidoc +++ b/x-pack/docs/en/rest-api/security/disable-user-profile.asciidoc @@ -5,7 +5,10 @@ Disable 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. Disables a user profile so it's not visible in <>. diff --git a/x-pack/docs/en/rest-api/security/enable-user-profile.asciidoc b/x-pack/docs/en/rest-api/security/enable-user-profile.asciidoc index 7d163c8f164df..c61e847cfd1f1 100644 --- a/x-pack/docs/en/rest-api/security/enable-user-profile.asciidoc +++ b/x-pack/docs/en/rest-api/security/enable-user-profile.asciidoc @@ -5,7 +5,10 @@ Enable 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. Enables a user profile so it's visible in <>. diff --git a/x-pack/docs/en/rest-api/security/get-user-profile.asciidoc b/x-pack/docs/en/rest-api/security/get-user-profile.asciidoc index ff8b3d278795a..9f0ba64d136ac 100644 --- a/x-pack/docs/en/rest-api/security/get-user-profile.asciidoc +++ b/x-pack/docs/en/rest-api/security/get-user-profile.asciidoc @@ -5,7 +5,10 @@ Get 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. Retrieves user profiles using a list of unique profile ID. diff --git a/x-pack/docs/en/rest-api/security/has-privileges-user-profile.asciidoc b/x-pack/docs/en/rest-api/security/has-privileges-user-profile.asciidoc index e87d620c11c82..6f2d234395e95 100644 --- a/x-pack/docs/en/rest-api/security/has-privileges-user-profile.asciidoc +++ b/x-pack/docs/en/rest-api/security/has-privileges-user-profile.asciidoc @@ -4,9 +4,11 @@ ++++ Has privileges user profile ++++ -[[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 <> IDs have all the requested privileges. diff --git a/x-pack/docs/en/rest-api/security/suggest-user-profile.asciidoc b/x-pack/docs/en/rest-api/security/suggest-user-profile.asciidoc index 3c99701792434..ad01987a1e704 100644 --- a/x-pack/docs/en/rest-api/security/suggest-user-profile.asciidoc +++ b/x-pack/docs/en/rest-api/security/suggest-user-profile.asciidoc @@ -5,7 +5,10 @@ Suggest 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. Get suggestions for user profiles that match specified search criteria. diff --git a/x-pack/docs/en/rest-api/security/update-user-profile-data.asciidoc b/x-pack/docs/en/rest-api/security/update-user-profile-data.asciidoc index a3b9f49f2f70b..d4c89558c3fca 100644 --- a/x-pack/docs/en/rest-api/security/update-user-profile-data.asciidoc +++ b/x-pack/docs/en/rest-api/security/update-user-profile-data.asciidoc @@ -5,7 +5,10 @@ Update user profile data ++++ -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. diff --git a/x-pack/docs/en/security/authentication/security-domain.asciidoc b/x-pack/docs/en/security/authentication/security-domain.asciidoc index 3fa442eed712b..4800fec1a1134 100644 --- a/x-pack/docs/en/security/authentication/security-domain.asciidoc +++ b/x-pack/docs/en/security/authentication/security-domain.asciidoc @@ -2,8 +2,6 @@ [[security-domain]] === Security domains -beta::[] - Security domains are a method of grouping multiple <> 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 diff --git a/x-pack/docs/en/security/authentication/user-profile.asciidoc b/x-pack/docs/en/security/authentication/user-profile.asciidoc index 2a001895b71aa..375e7bf9e14a0 100644 --- a/x-pack/docs/en/security/authentication/user-profile.asciidoc +++ b/x-pack/docs/en/security/authentication/user-profile.asciidoc @@ -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