Skip to content

Commit

Permalink
[DOCS] Add feature flag admonition for user profiles (elastic#88356)
Browse files Browse the repository at this point in the history
* [DOCS] Add feature flag admonition

* Remove ifeval for security domains and user profile pages
  • Loading branch information
Adam Locke authored Jul 8, 2022
1 parent 031a174 commit d27e542
Show file tree
Hide file tree
Showing 11 changed files with 14 additions and 21 deletions.
8 changes: 3 additions & 5 deletions x-pack/docs/en/rest-api/security.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -132,11 +132,12 @@ communicate with a secured {es} cluster.
* <<security-api-node-enrollment, Enroll a new node>>
* <<security-api-kibana-enrollment, Enroll a new {kib} instance>>

ifeval::["{release-state}"!="released"]
[discrete]
[[security-user-profile-apis]]
=== User Profile

IMPORTANT: {es-feature-flag}

Use the following APIs to retrieve and manage user profiles.

* <<security-api-activate-user-profile, Activate user profile>>
Expand All @@ -145,8 +146,7 @@ Use the following APIs to retrieve and manage user profiles.
* <<security-api-enable-user-profile, Enable user profile>>
* <<security-api-disable-user-profile, Disable user profile>>
* <<security-api-suggest-user-profile, Suggest user profile>>
* <<security-api-has-privileges-user-profile, Has Privileges user profile>>
endif::[]
* <<security-api-has-privileges-user-profile, Has privileges user profile>>

include::security/authenticate.asciidoc[]
include::security/change-password.asciidoc[]
Expand Down Expand Up @@ -197,12 +197,10 @@ include::security/saml-invalidate-api.asciidoc[]
include::security/saml-complete-logout-api.asciidoc[]
include::security/saml-sp-metadata.asciidoc[]
include::security/ssl.asciidoc[]
ifeval::["{release-state}"!="released"]
include::security/activate-user-profile.asciidoc[]
include::security/disable-user-profile.asciidoc[]
include::security/enable-user-profile.asciidoc[]
include::security/get-user-profile.asciidoc[]
include::security/suggest-user-profile.asciidoc[]
include::security/update-user-profile-data.asciidoc[]
include::security/has-privileges-user-profile.asciidoc[]
endif::[]
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<titleabbrev>Activate user profile</titleabbrev>
++++

beta::[]
IMPORTANT: {es-feature-flag}

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,7 @@
<titleabbrev>Disable user profile</titleabbrev>
++++

beta::[]
IMPORTANT: {es-feature-flag}

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,7 @@
<titleabbrev>Enable user profile</titleabbrev>
++++

beta::[]
IMPORTANT: {es-feature-flag}

Enables a user profile so it's visible in
<<security-api-suggest-user-profile,user profile searches>>.
Expand Down
2 changes: 1 addition & 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,7 @@
<titleabbrev>Get user profile</titleabbrev>
++++

beta::[]
IMPORTANT: {es-feature-flag}

Retrieves a user's profile using the unique profile ID.

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

beta::[]
IMPORTANT: {es-feature-flag}

Determines whether the users associated with the specified <<user-profile, user profile>> IDs
have all the requested privileges.
Determines whether the users associated with the specified
<<user-profile,user profile>> IDs have all the requested privileges.

[[security-api-has-privileges-user-profile-request]]
==== {api-request-title}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<titleabbrev>Suggest user profile</titleabbrev>
++++

beta::[]
IMPORTANT: {es-feature-flag}

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,7 @@
<titleabbrev>Update user profile data</titleabbrev>
++++

beta::[]
IMPORTANT: {es-feature-flag}

Updates specific data for the user profile that's associated with the specified
unique ID.
Expand Down
4 changes: 0 additions & 4 deletions x-pack/docs/en/security/authentication/overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,10 @@ include::built-in-users.asciidoc[][]
include::service-accounts.asciidoc[]
include::internal-users.asciidoc[]
include::token-authentication-services.asciidoc[]
ifeval::["{release-state}"!="released"]
include::user-profile.asciidoc[]
endif::[]
include::realms.asciidoc[]
include::realm-chains.asciidoc[]
ifeval::["{release-state}"!="released"]
include::security-domain.asciidoc[]
endif::[]
include::active-directory-realm.asciidoc[]
include::file-realm.asciidoc[]
include::ldap-realm.asciidoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[[security-domain]]
=== Security domains

beta::[]
IMPORTANT: {es-feature-flag}

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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[[user-profile]]
=== User profiles

beta::[]
IMPORTANT: {es-feature-flag}

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 d27e542

Please sign in to comment.