elasticsearch 8.17.1__py3-none-any.whl → 8.17.2__py3-none-any.whl

elasticsearch/_async/client/security.py

@@ -44,21 +44,19 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Activate a user profile. Create or update a user profile on behalf of another
-        user. NOTE: The user profile feature is designed only for use by Kibana and Elastic's
-        Observability, Enterprise Search, and Elastic Security solutions. Individual
-        users and external applications should not call this API directly. The calling
-        application must have either an `access_token` or a combination of `username`
-        and `password` for the user that the profile document is intended for. Elastic
-        reserves the right to change or remove this feature in future releases without
-        prior notice. This API creates or updates a profile document for end users with
-        information that is extracted from the user's authentication object including
-        `username`, `full_name,` `roles`, and the authentication realm. For example,
-        in the JWT `access_token` case, the profile user's `username` is extracted from
-        the JWT token claim pointed to by the `claims.principal` setting of the JWT realm
-        that authenticated the token. When updating a profile document, the API enables
-        the document if it was disabled. Any updates do not change existing content for
-        either the `labels` or `data` fields.
+        .. raw:: html
+
+          <p>Activate a user profile.</p>
+          <p>Create or update a user profile on behalf of another user.</p>
+          <p>NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.
+          Individual users and external applications should not call this API directly.
+          The calling application must have either an <code>access_token</code> or a combination of <code>username</code> and <code>password</code> for the user that the profile document is intended for.
+          Elastic reserves the right to change or remove this feature in future releases without prior notice.</p>
+          <p>This API creates or updates a profile document for end users with information that is extracted from the user's authentication object including <code>username</code>, <code>full_name,</code> <code>roles</code>, and the authentication realm.
+          For example, in the JWT <code>access_token</code> case, the profile user's <code>username</code> is extracted from the JWT token claim pointed to by the <code>claims.principal</code> setting of the JWT realm that authenticated the token.</p>
+          <p>When updating a profile document, the API enables the document if it was disabled.
+          Any updates do not change existing content for either the <code>labels</code> or <code>data</code> fields.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-activate-user-profile.html>`_
 
@@ -117,12 +115,14 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Authenticate a user. Authenticates a user and returns information about the authenticated
-        user. Include the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).
-        A successful call returns a JSON structure that shows user information such as
-        their username, the roles that are assigned to the user, any assigned metadata,
-        and information about the realms that authenticated and authorized the user.
-        If the user cannot be authenticated, this API returns a 401 status code.
+        .. raw:: html
+
+          <p>Authenticate a user.</p>
+          <p>Authenticates a user and returns information about the authenticated user.
+          Include the user information in a <a href="https://en.wikipedia.org/wiki/Basic_access_authentication">basic auth header</a>.
+          A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.
+          If the user cannot be authenticated, this API returns a 401 status code.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-authenticate.html>`_
         """
@@ -164,9 +164,12 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Bulk delete roles. The role management APIs are generally the preferred way to
-        manage roles, rather than using file-based role management. The bulk delete roles
-        API cannot delete roles that are defined in roles files.
+        .. raw:: html
+
+          <p>Bulk delete roles.</p>
+          <p>The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
+          The bulk delete roles API cannot delete roles that are defined in roles files.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-bulk-delete-role.html>`_
 
@@ -222,9 +225,12 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Bulk create or update roles. The role management APIs are generally the preferred
-        way to manage roles, rather than using file-based role management. The bulk create
-        or update roles API cannot update roles that are defined in roles files.
+        .. raw:: html
+
+          <p>Bulk create or update roles.</p>
+          <p>The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
+          The bulk create or update roles API cannot update roles that are defined in roles files.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-bulk-put-role.html>`_
 
@@ -280,23 +286,19 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Bulk update API keys. Update the attributes for multiple API keys. IMPORTANT:
-        It is not possible to use an API key as the authentication credential for this
-        API. To update API keys, the owner user's credentials are required. This API
-        is similar to the update API key API but enables you to apply the same update
-        to multiple API keys in one API call. This operation can greatly improve performance
-        over making individual updates. It is not possible to update expired or invalidated
-        API keys. This API supports updates to API key access scope, metadata and expiration.
-        The access scope of each API key is derived from the `role_descriptors` you specify
-        in the request and a snapshot of the owner user's permissions at the time of
-        the request. The snapshot of the owner's permissions is updated automatically
-        on every call. IMPORTANT: If you don't specify `role_descriptors` in the request,
-        a call to this API might still change an API key's access scope. This change
-        can occur if the owner user's permissions have changed since the API key was
-        created or last modified. A successful request returns a JSON structure that
-        contains the IDs of all updated API keys, the IDs of API keys that already had
-        the requested changes and did not require an update, and error details for any
-        failed update.
+        .. raw:: html
+
+          <p>Bulk update API keys.
+          Update the attributes for multiple API keys.</p>
+          <p>IMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.</p>
+          <p>This API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.</p>
+          <p>It is not possible to update expired or invalidated API keys.</p>
+          <p>This API supports updates to API key access scope, metadata and expiration.
+          The access scope of each API key is derived from the <code>role_descriptors</code> you specify in the request and a snapshot of the owner user's permissions at the time of the request.
+          The snapshot of the owner's permissions is updated automatically on every call.</p>
+          <p>IMPORTANT: If you don't specify <code>role_descriptors</code> in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.</p>
+          <p>A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-bulk-update-api-keys.html>`_
 
@@ -370,8 +372,11 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Change passwords. Change the passwords of users in the native realm and built-in
-        users.
+        .. raw:: html
+
+          <p>Change passwords.</p>
+          <p>Change the passwords of users in the native realm and built-in users.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-change-password.html>`_
 
@@ -433,8 +438,12 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Clear the API key cache. Evict a subset of all entries from the API key cache.
-        The cache is also automatically cleared on state changes of the security index.
+        .. raw:: html
+
+          <p>Clear the API key cache.</p>
+          <p>Evict a subset of all entries from the API key cache.
+          The cache is also automatically cleared on state changes of the security index.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-clear-api-key-cache.html>`_
 
@@ -475,13 +484,17 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Clear the privileges cache. Evict privileges from the native application privilege
-        cache. The cache is also automatically cleared for applications that have their
-        privileges updated.
+        .. raw:: html
+
+          <p>Clear the privileges cache.</p>
+          <p>Evict privileges from the native application privilege cache.
+          The cache is also automatically cleared for applications that have their privileges updated.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-clear-privilege-cache.html>`_
 
-        :param application: A comma-separated list of application names
+        :param application: A comma-separated list of applications. To clear all applications,
+            use an asterism (`*`). It does not support other wildcard patterns.
         """
         if application in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'application'")
@@ -518,13 +531,23 @@ class SecurityClient(NamespacedClient):
         usernames: t.Optional[t.Sequence[str]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Clear the user cache. Evict users from the user cache. You can completely clear
-        the cache or evict specific users.
+        .. raw:: html
+
+          <p>Clear the user cache.</p>
+          <p>Evict users from the user cache.
+          You can completely clear the cache or evict specific users.</p>
+          <p>User credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.
+          There are realm settings that you can use to configure the user cache.
+          For more information, refer to the documentation about controlling the user cache.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-clear-cache.html>`_
 
-        :param realms: Comma-separated list of realms to clear
-        :param usernames: Comma-separated list of usernames to clear from the cache
+        :param realms: A comma-separated list of realms. To clear all realms, use an
+            asterisk (`*`). It does not support other wildcard patterns.
+        :param usernames: A comma-separated list of the users to clear from the cache.
+            If you do not specify this parameter, the API evicts all users from the user
+            cache.
         """
         if realms in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'realms'")
@@ -562,11 +585,17 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Clear the roles cache. Evict roles from the native role cache.
+        .. raw:: html
+
+          <p>Clear the roles cache.</p>
+          <p>Evict roles from the native role cache.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-clear-role-cache.html>`_
 
-        :param name: Role name
+        :param name: A comma-separated list of roles to evict from the role cache. To
+            evict all roles, use an asterisk (`*`). It does not support other wildcard
+            patterns.
         """
         if name in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'name'")
@@ -604,14 +633,23 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Clear service account token caches. Evict a subset of all entries from the service
-        account token caches.
+        .. raw:: html
+
+          <p>Clear service account token caches.</p>
+          <p>Evict a subset of all entries from the service account token caches.
+          Two separate caches exist for service account tokens: one cache for tokens backed by the <code>service_tokens</code> file, and another for tokens backed by the <code>.security</code> index.
+          This API clears matching entries from both caches.</p>
+          <p>The cache for service account tokens backed by the <code>.security</code> index is cleared automatically on state changes of the security index.
+          The cache for tokens backed by the <code>service_tokens</code> file is cleared automatically on file changes.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-clear-service-token-caches.html>`_
 
-        :param namespace: An identifier for the namespace
-        :param service: An identifier for the service name
-        :param name: A comma-separated list of service token names
+        :param namespace: The namespace, which is a top-level grouping of service accounts.
+        :param service: The name of the service, which must be unique within its namespace.
+        :param name: A comma-separated list of token names to evict from the service
+            account token caches. Use a wildcard (`*`) to evict all tokens that belong
+            to a service account. It does not support other wildcard patterns.
         """
         if namespace in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'namespace'")
@@ -664,31 +702,43 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create an API key. Create an API key for access without requiring basic authentication.
-        A successful request returns a JSON structure that contains the API key, its
-        unique id, and its name. If applicable, it also returns expiration information
-        for the API key in milliseconds. NOTE: By default, API keys never expire. You
-        can specify expiration information when you create the API keys.
+        .. raw:: html
+
+          <p>Create an API key.</p>
+          <p>Create an API key for access without requiring basic authentication.</p>
+          <p>IMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.
+          If you specify privileges, the API returns an error.</p>
+          <p>A successful request returns a JSON structure that contains the API key, its unique id, and its name.
+          If applicable, it also returns expiration information for the API key in milliseconds.</p>
+          <p>NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.</p>
+          <p>The API keys are created by the Elasticsearch API key service, which is automatically enabled.
+          To configure or turn off the API key service, refer to API key service setting documentation.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-create-api-key.html>`_
 
-        :param expiration: Expiration time for the API key. By default, API keys never
-            expire.
+        :param expiration: The expiration time for the API key. By default, API keys
+            never expire.
         :param metadata: Arbitrary metadata that you want to associate with the API key.
             It supports nested data structure. Within the metadata object, keys beginning
             with `_` are reserved for system usage.
-        :param name: Specifies the name for this API key.
+        :param name: A name for the API key.
         :param refresh: If `true` (the default) then refresh the affected shards to make
             this operation visible to search, if `wait_for` then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
-        :param role_descriptors: An array of role descriptors for this API key. This
-            parameter is optional. When it is not specified or is an empty array, then
-            the API key will have a point in time snapshot of permissions of the authenticated
-            user. If you supply role descriptors then the resultant permissions would
-            be an intersection of API keys permissions and authenticated user’s permissions
-            thereby limiting the access scope for API keys. The structure of role descriptor
-            is the same as the request for create role API. For more details, see create
-            or update roles API.
+        :param role_descriptors: An array of role descriptors for this API key. When
+            it is not specified or it is an empty array, the API key will have a point
+            in time snapshot of permissions of the authenticated user. If you supply
+            role descriptors, the resultant permissions are an intersection of API keys
+            permissions and the authenticated user's permissions thereby limiting the
+            access scope for API keys. The structure of role descriptor is the same as
+            the request for the create role API. For more details, refer to the create
+            or update roles API. NOTE: Due to the way in which this permission intersection
+            is calculated, it is not possible to create an API key that is a child of
+            another API key, unless the derived key is created without any privileges.
+            In this case, you must explicitly specify a role descriptor with no privileges.
+            The derived API key can be used for authentication; it will not have authority
+            to call Elasticsearch APIs.
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_security/api_key"
@@ -741,21 +791,19 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create a cross-cluster API key. Create an API key of the `cross_cluster` type
-        for the API key based remote cluster access. A `cross_cluster` API key cannot
-        be used to authenticate through the REST interface. IMPORTANT: To authenticate
-        this request you must use a credential that is not an API key. Even if you use
-        an API key that has the required privilege, the API returns an error. Cross-cluster
-        API keys are created by the Elasticsearch API key service, which is automatically
-        enabled. NOTE: Unlike REST API keys, a cross-cluster API key does not capture
-        permissions of the authenticated user. The API key’s effective permission is
-        exactly as specified with the `access` property. A successful request returns
-        a JSON structure that contains the API key, its unique ID, and its name. If applicable,
-        it also returns expiration information for the API key in milliseconds. By default,
-        API keys never expire. You can specify expiration information when you create
-        the API keys. Cross-cluster API keys can only be updated with the update cross-cluster
-        API key API. Attempting to update them with the update REST API key API or the
-        bulk update REST API keys API will result in an error.
+        .. raw:: html
+
+          <p>Create a cross-cluster API key.</p>
+          <p>Create an API key of the <code>cross_cluster</code> type for the API key based remote cluster access.
+          A <code>cross_cluster</code> API key cannot be used to authenticate through the REST interface.</p>
+          <p>IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.</p>
+          <p>Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.</p>
+          <p>NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the <code>access</code> property.</p>
+          <p>A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.</p>
+          <p>By default, API keys never expire. You can specify expiration information when you create the API keys.</p>
+          <p>Cross-cluster API keys can only be updated with the update cross-cluster API key API.
+          Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-create-cross-cluster-api-key.html>`_
 
@@ -824,14 +872,26 @@ class SecurityClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create a service account token. Create a service accounts token for access without
-        requiring basic authentication.
+        .. raw:: html
+
+          <p>Create a service account token.</p>
+          <p>Create a service accounts token for access without requiring basic authentication.</p>
+          <p>NOTE: Service account tokens never expire.
+          You must actively delete them if they are no longer needed.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-create-service-token.html>`_
 
-        :param namespace: An identifier for the namespace
-        :param service: An identifier for the service name
-        :param name: An identifier for the token name
+        :param namespace: The name of the namespace, which is a top-level grouping of
+            service accounts.
+        :param service: The name of the service.
+        :param name: The name for the service account token. If omitted, a random name
+            will be generated. Token names must be at least one and no more than 256
+            characters. They can contain alphanumeric characters (a-z, A-Z, 0-9), dashes
+            (`-`), and underscores (`_`), but cannot begin with an underscore. NOTE:
+            Token names must be unique in the context of the associated service account.
+            They must also be globally unique with their fully qualified names, which
+            are comprised of the service account principal and token name, such as `<namespace>/<service>/<token-name>`.
         :param refresh: If `true` then refresh the affected shards to make this operation
             visible to search, if `wait_for` (the default) then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
@@ -894,20 +954,17 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delegate PKI authentication. This API implements the exchange of an X509Certificate
-        chain for an Elasticsearch access token. The certificate chain is validated,
-        according to RFC 5280, by sequentially considering the trust configuration of
-        every installed PKI realm that has `delegation.enabled` set to `true`. A successfully
-        trusted client certificate is also subject to the validation of the subject distinguished
-        name according to thw `username_pattern` of the respective realm. This API is
-        called by smart and trusted proxies, such as Kibana, which terminate the user's
-        TLS session but still want to authenticate the user by using a PKI realm—-​as
-        if the user connected directly to Elasticsearch. IMPORTANT: The association between
-        the subject public key in the target certificate and the corresponding private
-        key is not validated. This is part of the TLS authentication process and it is
-        delegated to the proxy that calls this API. The proxy is trusted to have performed
-        the TLS authentication and this API translates that authentication into an Elasticsearch
-        access token.
+        .. raw:: html
+
+          <p>Delegate PKI authentication.</p>
+          <p>This API implements the exchange of an X509Certificate chain for an Elasticsearch access token.
+          The certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has <code>delegation.enabled</code> set to <code>true</code>.
+          A successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw <code>username_pattern</code> of the respective realm.</p>
+          <p>This API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-​as if the user connected directly to Elasticsearch.</p>
+          <p>IMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated.
+          This is part of the TLS authentication process and it is delegated to the proxy that calls this API.
+          The proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delegate-pki-authentication.html>`_
 
@@ -963,12 +1020,21 @@ class SecurityClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete application privileges.
+        .. raw:: html
+
+          <p>Delete application privileges.</p>
+          <p>To use this API, you must have one of the following privileges:</p>
+          <ul>
+          <li>The <code>manage_security</code> cluster privilege (or a greater privilege such as <code>all</code>).</li>
+          <li>The &quot;Manage Application Privileges&quot; global privilege for the application being referenced in the request.</li>
+          </ul>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-privilege.html>`_
 
-        :param application: Application name
-        :param name: Privilege name
+        :param application: The name of the application. Application privileges are always
+            associated with exactly one application.
+        :param name: The name of the privilege.
         :param refresh: If `true` (the default) then refresh the affected shards to make
             this operation visible to search, if `wait_for` then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
@@ -1019,11 +1085,17 @@ class SecurityClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete roles. Delete roles in the native realm.
+        .. raw:: html
+
+          <p>Delete roles.</p>
+          <p>Delete roles in the native realm.
+          The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
+          The delete roles API cannot remove roles that are defined in roles files.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-role.html>`_
 
-        :param name: Role name
+        :param name: The name of the role.
         :param refresh: If `true` (the default) then refresh the affected shards to make
             this operation visible to search, if `wait_for` then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
@@ -1067,11 +1139,19 @@ class SecurityClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete role mappings.
+        .. raw:: html
+
+          <p>Delete role mappings.</p>
+          <p>Role mappings define which roles are assigned to each user.
+          The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.
+          The delete role mappings API cannot remove role mappings that are defined in role mapping files.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-role-mapping.html>`_
 
-        :param name: Role-mapping name
+        :param name: The distinct name that identifies the role mapping. The name is
+            used solely as an identifier to facilitate interaction via the API; it does
+            not affect the behavior of the mapping in any way.
         :param refresh: If `true` (the default) then refresh the affected shards to make
             this operation visible to search, if `wait_for` then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
@@ -1117,14 +1197,17 @@ class SecurityClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete service account tokens. Delete service account tokens for a service in
-        a specified namespace.
+        .. raw:: html
+
+          <p>Delete service account tokens.</p>
+          <p>Delete service account tokens for a service in a specified namespace.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-service-token.html>`_
 
-        :param namespace: An identifier for the namespace
-        :param service: An identifier for the service name
-        :param name: An identifier for the token name
+        :param namespace: The namespace, which is a top-level grouping of service accounts.
+        :param service: The service name.
+        :param name: The name of the service account token.
         :param refresh: If `true` then refresh the affected shards to make this operation
             visible to search, if `wait_for` (the default) then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
@@ -1176,11 +1259,15 @@ class SecurityClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete users. Delete users from the native realm.
+        .. raw:: html
+
+          <p>Delete users.</p>
+          <p>Delete users from the native realm.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-user.html>`_
 
-        :param username: username
+        :param username: An identifier for the user.
         :param refresh: If `true` (the default) then refresh the affected shards to make
             this operation visible to search, if `wait_for` then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
@@ -1224,11 +1311,17 @@ class SecurityClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Disable users. Disable users in the native realm.
+        .. raw:: html
+
+          <p>Disable users.</p>
+          <p>Disable users in the native realm.
+          By default, when you create users, they are enabled.
+          You can use this API to revoke a user's access to Elasticsearch.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-disable-user.html>`_
 
-        :param username: The username of the user to disable
+        :param username: An identifier for the user.
         :param refresh: If `true` (the default) then refresh the affected shards to make
             this operation visible to search, if `wait_for` then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
@@ -1272,15 +1365,16 @@ class SecurityClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Disable a user profile. Disable user profiles so that they are not visible in
-        user profile searches. NOTE: The user profile feature is designed only for use
-        by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security
-        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. When you activate a user profile, its automatically
-        enabled and visible in user profile searches. You can use the disable user profile
-        API to disable a user profile so it’s not visible in these searches. To re-enable
-        a disabled user profile, use the enable user profile API .
+        .. raw:: html
+
+          <p>Disable a user profile.</p>
+          <p>Disable user profiles so that they are not visible in user profile searches.</p>
+          <p>NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security 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.</p>
+          <p>When you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches.
+          To re-enable a disabled user profile, use the enable user profile API .</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-disable-user-profile.html>`_
 
@@ -1328,11 +1422,16 @@ class SecurityClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Enable users. Enable users in the native realm.
+        .. raw:: html
+
+          <p>Enable users.</p>
+          <p>Enable users in the native realm.
+          By default, when you create users, they are enabled.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-enable-user.html>`_
 
-        :param username: The username of the user to enable
+        :param username: An identifier for the user.
         :param refresh: If `true` (the default) then refresh the affected shards to make
             this operation visible to search, if `wait_for` then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
@@ -1376,14 +1475,16 @@ class SecurityClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Enable a user profile. Enable user profiles to make them visible in user profile
-        searches. NOTE: The user profile feature is designed only for use by Kibana and
-        Elastic's Observability, Enterprise Search, and Elastic Security 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.
-        When you activate a user profile, it's automatically enabled and visible in user
-        profile searches. If you later disable the user profile, you can use the enable
-        user profile API to make the profile visible in these searches again.
+        .. raw:: html
+
+          <p>Enable a user profile.</p>
+          <p>Enable user profiles to make them visible in user profile searches.</p>
+          <p>NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security 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.</p>
+          <p>When you activate a user profile, it's automatically enabled and visible in user profile searches.
+          If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-enable-user-profile.html>`_
 
@@ -1427,8 +1528,13 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Enroll Kibana. Enable a Kibana instance to configure itself for communication
-        with a secured Elasticsearch cluster.
+        .. raw:: html
+
+          <p>Enroll Kibana.</p>
+          <p>Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.</p>
+          <p>NOTE: This API is currently intended for internal use only by Kibana.
+          Kibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-kibana-enrollment.html>`_
         """
@@ -1463,8 +1569,13 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Enroll a node. Enroll a new node to allow it to join an existing cluster with
-        security features enabled.
+        .. raw:: html
+
+          <p>Enroll a node.</p>
+          <p>Enroll a new node to allow it to join an existing cluster with security features enabled.</p>
+          <p>The response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster.
+          The response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-node-enrollment.html>`_
         """
@@ -1507,11 +1618,13 @@ class SecurityClient(NamespacedClient):
         with_profile_uid: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get API key information. Retrieves information for one or more API keys. NOTE:
-        If you have only the `manage_own_api_key` privilege, this API returns only the
-        API keys that you own. If you have `read_security`, `manage_api_key` or greater
-        privileges (including `manage_security`), this API returns all API keys regardless
-        of ownership.
+        .. raw:: html
+
+          <p>Get API key information.</p>
+          <p>Retrieves information for one or more API keys.
+          NOTE: If you have only the <code>manage_own_api_key</code> privilege, this API returns only the API keys that you own.
+          If you have <code>read_security</code>, <code>manage_api_key</code> or greater privileges (including <code>manage_security</code>), this API returns all API keys regardless of ownership.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-api-key.html>`_
 
@@ -1585,8 +1698,11 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get builtin privileges. Get the list of cluster privileges and index privileges
-        that are available in this version of Elasticsearch.
+        .. raw:: html
+
+          <p>Get builtin privileges.</p>
+          <p>Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-builtin-privileges.html>`_
         """
@@ -1623,12 +1739,23 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get application privileges.
+        .. raw:: html
+
+          <p>Get application privileges.</p>
+          <p>To use this API, you must have one of the following privileges:</p>
+          <ul>
+          <li>The <code>read_security</code> cluster privilege (or a greater privilege such as <code>manage_security</code> or <code>all</code>).</li>
+          <li>The &quot;Manage Application Privileges&quot; global privilege for the application being referenced in the request.</li>
+          </ul>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-privileges.html>`_
 
-        :param application: Application name
-        :param name: Privilege name
+        :param application: The name of the application. Application privileges are always
+            associated with exactly one application. If you do not specify this parameter,
+            the API returns information about all privileges for all applications.
+        :param name: The name of the privilege. If you do not specify this parameter,
+            the API returns information about all privileges for the requested application.
         """
         __path_parts: t.Dict[str, str]
         if application not in SKIP_IN_PATH and name not in SKIP_IN_PATH:
@@ -1670,9 +1797,13 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get roles. Get roles in the native realm. The role management APIs are generally
-        the preferred way to manage roles, rather than using file-based role management.
-        The get roles API cannot retrieve roles that are defined in roles files.
+        .. raw:: html
+
+          <p>Get roles.</p>
+          <p>Get roles in the native realm.
+          The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
+          The get roles API cannot retrieve roles that are defined in roles files.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-role.html>`_
 
@@ -1717,10 +1848,13 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get role mappings. Role mappings define which roles are assigned to each user.
-        The role mapping APIs are generally the preferred way to manage role mappings
-        rather than using role mapping files. The get role mappings API cannot retrieve
-        role mappings that are defined in role mapping files.
+        .. raw:: html
+
+          <p>Get role mappings.</p>
+          <p>Role mappings define which roles are assigned to each user.
+          The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.
+          The get role mappings API cannot retrieve role mappings that are defined in role mapping files.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-role-mapping.html>`_
 
@@ -1768,15 +1902,19 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get service accounts. Get a list of service accounts that match the provided
-        path parameters.
+        .. raw:: html
+
+          <p>Get service accounts.</p>
+          <p>Get a list of service accounts that match the provided path parameters.</p>
+          <p>NOTE: Currently, only the <code>elastic/fleet-server</code> service account is available.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-service-accounts.html>`_
 
-        :param namespace: Name of the namespace. Omit this parameter to retrieve information
-            about all service accounts. If you omit this parameter, you must also omit
-            the `service` parameter.
-        :param service: Name of the service name. Omit this parameter to retrieve information
+        :param namespace: The name of the namespace. Omit this parameter to retrieve
+            information about all service accounts. If you omit this parameter, you must
+            also omit the `service` parameter.
+        :param service: The service name. Omit this parameter to retrieve information
             about all service accounts that belong to the specified `namespace`.
         """
         __path_parts: t.Dict[str, str]
@@ -1820,12 +1958,19 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get service account credentials.
+        .. raw:: html
+
+          <p>Get service account credentials.</p>
+          <p>To use this API, you must have at least the <code>read_security</code> cluster privilege (or a greater privilege such as <code>manage_service_account</code> or <code>manage_security</code>).</p>
+          <p>The response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.</p>
+          <p>NOTE: For tokens backed by the <code>service_tokens</code> file, the API collects them from all nodes of the cluster.
+          Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-service-credentials.html>`_
 
-        :param namespace: Name of the namespace.
-        :param service: Name of the service name.
+        :param namespace: The name of the namespace.
+        :param service: The service name.
         """
         if namespace in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'namespace'")
@@ -1866,8 +2011,17 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get security index settings. Get the user-configurable settings for the security
-        internal index (`.security` and associated indices).
+        .. raw:: html
+
+          <p>Get security index settings.</p>
+          <p>Get the user-configurable settings for the security internal index (<code>.security</code> and associated indices).
+          Only a subset of the index settings — those that are user-configurable—will be shown.
+          This includes:</p>
+          <ul>
+          <li><code>index.auto_expand_replicas</code></li>
+          <li><code>index.number_of_replicas</code></li>
+          </ul>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-settings.html>`_
 
@@ -1931,16 +2085,39 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get a token. Create a bearer token for access without requiring basic authentication.
+        .. raw:: html
+
+          <p>Get a token.</p>
+          <p>Create a bearer token for access without requiring basic authentication.
+          The tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface.
+          Alternatively, you can explicitly enable the <code>xpack.security.authc.token.enabled</code> setting.
+          When you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface.</p>
+          <p>The get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body.</p>
+          <p>A successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available.</p>
+          <p>The tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used.
+          That time period is defined by the <code>xpack.security.authc.token.timeout</code> setting.
+          If you want to invalidate a token immediately, you can do so by using the invalidate token API.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-token.html>`_
 
-        :param grant_type:
-        :param kerberos_ticket:
-        :param password:
-        :param refresh_token:
-        :param scope:
-        :param username:
+        :param grant_type: The type of grant. Supported grant types are: `password`,
+            `_kerberos`, `client_credentials`, and `refresh_token`.
+        :param kerberos_ticket: The base64 encoded kerberos ticket. If you specify the
+            `_kerberos` grant type, this parameter is required. This parameter is not
+            valid with any other supported grant type.
+        :param password: The user's password. If you specify the `password` grant type,
+            this parameter is required. This parameter is not valid with any other supported
+            grant type.
+        :param refresh_token: The string that was returned when you created the token,
+            which enables you to extend its life. If you specify the `refresh_token`
+            grant type, this parameter is required. This parameter is not valid with
+            any other supported grant type.
+        :param scope: The scope of the token. Currently tokens are only issued for a
+            scope of FULL regardless of the value sent with the request.
+        :param username: The username that identifies the user. If you specify the `password`
+            grant type, this parameter is required. This parameter is not valid with
+            any other supported grant type.
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_security/oauth2/token"
@@ -1990,15 +2167,19 @@ class SecurityClient(NamespacedClient):
         with_profile_uid: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get users. Get information about users in the native realm and built-in users.
+        .. raw:: html
+
+          <p>Get users.</p>
+          <p>Get information about users in the native realm and built-in users.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-user.html>`_
 
         :param username: An identifier for the user. You can specify multiple usernames
             as a comma-separated list. If you omit this parameter, the API retrieves
             information about all users.
-        :param with_profile_uid: If true will return the User Profile ID for a user,
-            if any.
+        :param with_profile_uid: Determines whether to retrieve the user profile UID,
+            if it exists, for the users.
         """
         __path_parts: t.Dict[str, str]
         if username not in SKIP_IN_PATH:
@@ -2041,7 +2222,14 @@ class SecurityClient(NamespacedClient):
         username: t.Optional[t.Union[None, str]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get user privileges.
+        .. raw:: html
+
+          <p>Get user privileges.</p>
+          <p>Get the security privileges for the logged in user.
+          All users can use this API, but only to determine their own privileges.
+          To check the privileges of other users, you must use the run as feature.
+          To check whether a user has a specific list of privileges, use the has privileges API.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-user-privileges.html>`_
 
@@ -2091,11 +2279,14 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get a user profile. Get a user's profile using the unique profile ID. NOTE: The
-        user profile feature is designed only for use by Kibana and Elastic's Observability,
-        Enterprise Search, and Elastic Security 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.
+        .. raw:: html
+
+          <p>Get a user profile.</p>
+          <p>Get a user's profile using the unique profile ID.</p>
+          <p>NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security 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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-user-profile.html>`_
 
@@ -2159,31 +2350,37 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Grant an API key. Create an API key on behalf of another user. This API is similar
-        to the create API keys API, however it creates the API key for a user that is
-        different than the user that runs the API. The caller must have authentication
-        credentials (either an access token, or a username and password) for the user
-        on whose behalf the API key will be created. It is not possible to use this API
-        to create an API key without that user’s credentials. The user, for whom the
-        authentication credentials is provided, can optionally "run as" (impersonate)
-        another user. In this case, the API key will be created on behalf of the impersonated
-        user. This API is intended be used by applications that need to create and manage
-        API keys for end users, but cannot guarantee that those users have permission
-        to create API keys on their own behalf. A successful grant API key API call returns
-        a JSON structure that contains the API key, its unique id, and its name. If applicable,
-        it also returns expiration information for the API key in milliseconds. By default,
-        API keys never expire. You can specify expiration information when you create
-        the API keys.
+        .. raw:: html
+
+          <p>Grant an API key.</p>
+          <p>Create an API key on behalf of another user.
+          This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API.
+          The caller must have authentication credentials for the user on whose behalf the API key will be created.
+          It is not possible to use this API to create an API key without that user's credentials.
+          The supported user authentication credential types are:</p>
+          <ul>
+          <li>username and password</li>
+          <li>Elasticsearch access tokens</li>
+          <li>JWTs</li>
+          </ul>
+          <p>The user, for whom the authentication credentials is provided, can optionally &quot;run as&quot; (impersonate) another user.
+          In this case, the API key will be created on behalf of the impersonated user.</p>
+          <p>This API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf.
+          The API keys are created by the Elasticsearch API key service, which is automatically enabled.</p>
+          <p>A successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.
+          If applicable, it also returns expiration information for the API key in milliseconds.</p>
+          <p>By default, API keys never expire. You can specify expiration information when you create the API keys.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-grant-api-key.html>`_
 
-        :param api_key: Defines the API key.
+        :param api_key: The API key.
         :param grant_type: The type of grant. Supported grant types are: `access_token`,
             `password`.
-        :param access_token: The user’s access token. If you specify the `access_token`
+        :param access_token: The user's access token. If you specify the `access_token`
             grant type, this parameter is required. It is not valid with other grant
             types.
-        :param password: The user’s password. If you specify the `password` grant type,
+        :param password: The user's password. If you specify the `password` grant type,
             this parameter is required. It is not valid with other grant types.
         :param run_as: The name of the user to be impersonated.
         :param username: The user name that identifies the user. If you specify the `password`
@@ -2314,8 +2511,13 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Check user privileges. Determine whether the specified user has a specified list
-        of privileges.
+        .. raw:: html
+
+          <p>Check user privileges.</p>
+          <p>Determine whether the specified user has a specified list of privileges.
+          All users can use this API, but only to determine their own privileges.
+          To check the privileges of other users, you must use the run as feature.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-has-privileges.html>`_
 
@@ -2374,12 +2576,13 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Check user profile privileges. Determine whether the users associated with the
-        specified user profile IDs have all the requested privileges. NOTE: The user
-        profile feature is designed only for use by Kibana and Elastic's Observability,
-        Enterprise Search, and Elastic Security 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.
+        .. raw:: html
+
+          <p>Check user profile privileges.</p>
+          <p>Determine whether the users associated with the specified user profile IDs have all the requested privileges.</p>
+          <p>NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security 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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-has-privileges-user-profile.html>`_
 
@@ -2438,17 +2641,22 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Invalidate API keys. This API invalidates API keys created by the create API
-        key or grant API key APIs. Invalidated API keys fail authentication, but they
-        can still be viewed using the get API key information and query API key information
-        APIs, for at least the configured retention period, until they are automatically
-        deleted. The `manage_api_key` privilege allows deleting any API keys. The `manage_own_api_key`
-        only allows deleting API keys that are owned by the user. In addition, with the
-        `manage_own_api_key` privilege, an invalidation request must be issued in one
-        of the three formats: - Set the parameter `owner=true`. - Or, set both `username`
-        and `realm_name` to match the user’s identity. - Or, if the request is issued
-        by an API key, that is to say an API key invalidates itself, specify its ID in
-        the `ids` field.
+        .. raw:: html
+
+          <p>Invalidate API keys.</p>
+          <p>This API invalidates API keys created by the create API key or grant API key APIs.
+          Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.</p>
+          <p>To use this API, you must have at least the <code>manage_security</code>, <code>manage_api_key</code>, or <code>manage_own_api_key</code> cluster privileges.
+          The <code>manage_security</code> privilege allows deleting any API key, including both REST and cross cluster API keys.
+          The <code>manage_api_key</code> privilege allows deleting any REST API key, but not cross cluster API keys.
+          The <code>manage_own_api_key</code> only allows deleting REST API keys that are owned by the user.
+          In addition, with the <code>manage_own_api_key</code> privilege, an invalidation request must be issued in one of the three formats:</p>
+          <ul>
+          <li>Set the parameter <code>owner=true</code>.</li>
+          <li>Or, set both <code>username</code> and <code>realm_name</code> to match the user's identity.</li>
+          <li>Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the <code>ids</code> field.</li>
+          </ul>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-invalidate-api-key.html>`_
 
@@ -2457,14 +2665,15 @@ class SecurityClient(NamespacedClient):
             `name`, `realm_name`, or `username`.
         :param name: An API key name. This parameter cannot be used with any of `ids`,
             `realm_name` or `username`.
-        :param owner: Can be used to query API keys owned by the currently authenticated
-            user. The `realm_name` or `username` parameters cannot be specified when
-            this parameter is set to `true` as they are assumed to be the currently authenticated
-            ones.
+        :param owner: Query API keys owned by the currently authenticated user. The `realm_name`
+            or `username` parameters cannot be specified when this parameter is set to
+            `true` as they are assumed to be the currently authenticated ones. NOTE:
+            At least one of `ids`, `name`, `username`, and `realm_name` must be specified
+            if `owner` is `false`.
         :param realm_name: The name of an authentication realm. This parameter cannot
             be used with either `ids` or `name`, or when `owner` flag is set to `true`.
         :param username: The username of a user. This parameter cannot be used with either
-            `ids` or `name`, or when `owner` flag is set to `true`.
+            `ids` or `name` or when `owner` flag is set to `true`.
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_security/api_key"
@@ -2519,19 +2728,30 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Invalidate a token. The access tokens returned by the get token API have a finite
-        period of time for which they are valid. After that time period, they can no
-        longer be used. The time period is defined by the `xpack.security.authc.token.timeout`
-        setting. The refresh tokens returned by the get token API are only valid for
-        24 hours. They can also be used exactly once. If you want to invalidate one or
-        more access or refresh tokens immediately, use this invalidate token API.
+        .. raw:: html
+
+          <p>Invalidate a token.</p>
+          <p>The access tokens returned by the get token API have a finite period of time for which they are valid.
+          After that time period, they can no longer be used.
+          The time period is defined by the <code>xpack.security.authc.token.timeout</code> setting.</p>
+          <p>The refresh tokens returned by the get token API are only valid for 24 hours.
+          They can also be used exactly once.
+          If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.</p>
+          <p>NOTE: While all parameters are optional, at least one of them is required.
+          More specifically, either one of <code>token</code> or <code>refresh_token</code> parameters is required.
+          If none of these two are specified, then <code>realm_name</code> and/or <code>username</code> need to be specified.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-invalidate-token.html>`_
 
-        :param realm_name:
-        :param refresh_token:
-        :param token:
-        :param username:
+        :param realm_name: The name of an authentication realm. This parameter cannot
+            be used with either `refresh_token` or `token`.
+        :param refresh_token: A refresh token. This parameter cannot be used if any of
+            `refresh_token`, `realm_name`, or `username` are used.
+        :param token: An access token. This parameter cannot be used if any of `refresh_token`,
+            `realm_name`, or `username` are used.
+        :param username: The username of a user. This parameter cannot be used with either
+            `refresh_token` or `token`.
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_security/oauth2/token"
@@ -2582,12 +2802,13 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Authenticate OpenID Connect. Exchange an OpenID Connect authentication response
-        message for an Elasticsearch internal access token and refresh token that can
-        be subsequently used for authentication. Elasticsearch exposes all the necessary
-        OpenID Connect related functionality with the OpenID Connect APIs. These APIs
-        are used internally by Kibana in order to provide OpenID Connect based authentication,
-        but can also be used by other, custom web applications or other clients.
+        .. raw:: html
+
+          <p>Authenticate OpenID Connect.</p>
+          <p>Exchange an OpenID Connect authentication response message for an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.</p>
+          <p>Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.
+          These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-oidc-authenticate.html>`_
 
@@ -2660,15 +2881,14 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Logout of OpenID Connect. Invalidate an access token and a refresh token that
-        were generated as a response to the `/_security/oidc/authenticate` API. If the
-        OpenID Connect authentication realm in Elasticsearch is accordingly configured,
-        the response to this call will contain a URI pointing to the end session endpoint
-        of the OpenID Connect Provider in order to perform single logout. Elasticsearch
-        exposes all the necessary OpenID Connect related functionality with the OpenID
-        Connect APIs. These APIs are used internally by Kibana in order to provide OpenID
-        Connect based authentication, but can also be used by other, custom web applications
-        or other clients.
+        .. raw:: html
+
+          <p>Logout of OpenID Connect.</p>
+          <p>Invalidate an access token and a refresh token that were generated as a response to the <code>/_security/oidc/authenticate</code> API.</p>
+          <p>If the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout.</p>
+          <p>Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.
+          These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-oidc-logout.html>`_
 
@@ -2723,15 +2943,14 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Prepare OpenID connect authentication. Create an oAuth 2.0 authentication request
-        as a URL string based on the configuration of the OpenID Connect authentication
-        realm in Elasticsearch. The response of this API is a URL pointing to the Authorization
-        Endpoint of the configured OpenID Connect Provider, which can be used to redirect
-        the browser of the user in order to continue the authentication process. Elasticsearch
-        exposes all the necessary OpenID Connect related functionality with the OpenID
-        Connect APIs. These APIs are used internally by Kibana in order to provide OpenID
-        Connect based authentication, but can also be used by other, custom web applications
-        or other clients.
+        .. raw:: html
+
+          <p>Prepare OpenID connect authentication.</p>
+          <p>Create an oAuth 2.0 authentication request as a URL string based on the configuration of the OpenID Connect authentication realm in Elasticsearch.</p>
+          <p>The response of this API is a URL pointing to the Authorization Endpoint of the configured OpenID Connect Provider, which can be used to redirect the browser of the user in order to continue the authentication process.</p>
+          <p>Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.
+          These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-oidc-prepare-authentication.html>`_
 
@@ -2808,7 +3027,26 @@ class SecurityClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update application privileges.
+        .. raw:: html
+
+          <p>Create or update application privileges.</p>
+          <p>To use this API, you must have one of the following privileges:</p>
+          <ul>
+          <li>The <code>manage_security</code> cluster privilege (or a greater privilege such as <code>all</code>).</li>
+          <li>The &quot;Manage Application Privileges&quot; global privilege for the application being referenced in the request.</li>
+          </ul>
+          <p>Application names are formed from a prefix, with an optional suffix that conform to the following rules:</p>
+          <ul>
+          <li>The prefix must begin with a lowercase ASCII letter.</li>
+          <li>The prefix must contain only ASCII letters or digits.</li>
+          <li>The prefix must be at least 3 characters long.</li>
+          <li>If the suffix exists, it must begin with either a dash <code>-</code> or <code>_</code>.</li>
+          <li>The suffix cannot contain any of the following characters: <code>\\</code>, <code>/</code>, <code>*</code>, <code>?</code>, <code>&quot;</code>, <code>&lt;</code>, <code>&gt;</code>, <code>|</code>, <code>,</code>, <code>*</code>.</li>
+          <li>No part of the name can contain whitespace.</li>
+          </ul>
+          <p>Privilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters <code>_</code>, <code>-</code>, and <code>.</code>.</p>
+          <p>Action names can contain any number of printable ASCII characters and must contain at least one of the following characters: <code>/</code>, <code>*</code>, <code>:</code>.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-put-privileges.html>`_
 
@@ -2954,10 +3192,13 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update roles. The role management APIs are generally the preferred
-        way to manage roles in the native realm, rather than using file-based role management.
-        The create or update roles API cannot update roles that are defined in roles
-        files. File-based role management is not available in Elastic Serverless.
+        .. raw:: html
+
+          <p>Create or update roles.</p>
+          <p>The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.
+          The create or update roles API cannot update roles that are defined in roles files.
+          File-based role management is not available in Elastic Serverless.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-put-role.html>`_
 
@@ -2976,7 +3217,10 @@ class SecurityClient(NamespacedClient):
             this operation visible to search, if `wait_for` then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
         :param remote_cluster: A list of remote cluster permissions entries.
-        :param remote_indices: A list of remote indices permissions entries.
+        :param remote_indices: A list of remote indices permissions entries. NOTE: Remote
+            indices are effective for remote clusters configured with the API key based
+            model. They have no effect for remote clusters configured with the certificate
+            based model.
         :param run_as: A list of users that the owners of this role can impersonate.
             *Note*: in Serverless, the run-as feature is disabled. For API compatibility,
             you can still specify an empty `run_as` field, but a non-empty list will
@@ -3066,26 +3310,48 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update role mappings. Role mappings define which roles are assigned
-        to each user. Each mapping has rules that identify users and a list of roles
-        that are granted to those users. The role mapping APIs are generally the preferred
-        way to manage role mappings rather than using role mapping files. The create
-        or update role mappings API cannot update role mappings that are defined in role
-        mapping files. This API does not create roles. Rather, it maps users to existing
-        roles. Roles can be created by using the create or update roles API or roles
-        files.
+        .. raw:: html
+
+          <p>Create or update role mappings.</p>
+          <p>Role mappings define which roles are assigned to each user.
+          Each mapping has rules that identify users and a list of roles that are granted to those users.
+          The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.</p>
+          <p>NOTE: This API does not create roles. Rather, it maps users to existing roles.
+          Roles can be created by using the create or update roles API or roles files.</p>
+          <p><strong>Role templates</strong></p>
+          <p>The most common use for role mappings is to create a mapping from a known value on the user to a fixed role name.
+          For example, all users in the <code>cn=admin,dc=example,dc=com</code> LDAP group should be given the superuser role in Elasticsearch.
+          The <code>roles</code> field is used for this purpose.</p>
+          <p>For more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user.
+          The <code>role_templates</code> field is used for this purpose.</p>
+          <p>NOTE: To use role templates successfully, the relevant scripting feature must be enabled.
+          Otherwise, all attempts to create a role mapping with role templates fail.</p>
+          <p>All of the user fields that are available in the role mapping rules are also available in the role templates.
+          Thus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated.</p>
+          <p>By default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user.
+          If the format of the template is set to &quot;json&quot; then the template is expected to produce a JSON string or an array of JSON strings for the role names.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-put-role-mapping.html>`_
 
-        :param name: Role-mapping name
-        :param enabled:
-        :param metadata:
+        :param name: The distinct name that identifies the role mapping. The name is
+            used solely as an identifier to facilitate interaction via the API; it does
+            not affect the behavior of the mapping in any way.
+        :param enabled: Mappings that have `enabled` set to `false` are ignored when
+            role mapping is performed.
+        :param metadata: Additional metadata that helps define which roles are assigned
+            to each user. Within the metadata object, keys beginning with `_` are reserved
+            for system usage.
         :param refresh: If `true` (the default) then refresh the affected shards to make
             this operation visible to search, if `wait_for` then wait for a refresh to
             make this operation visible to search, if `false` then do nothing with refreshes.
-        :param role_templates:
-        :param roles:
-        :param rules:
+        :param role_templates: A list of Mustache templates that will be evaluated to
+            determine the roles names that should granted to the users that match the
+            role mapping rules. Exactly one of `roles` or `role_templates` must be specified.
+        :param roles: A list of role names that are granted to the users that match the
+            role mapping rules. Exactly one of `roles` or `role_templates` must be specified.
+        :param rules: The rules that determine which users should be matched by the mapping.
+            A rule is a logical condition that is expressed by using a JSON DSL.
         :param run_as:
         """
         if name in SKIP_IN_PATH:
@@ -3160,23 +3426,41 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update users. A password is required for adding a new user but is optional
-        when updating an existing user. To change a user’s password without updating
-        any other fields, use the change password API.
+        .. raw:: html
+
+          <p>Create or update users.</p>
+          <p>Add and update users in the native realm.
+          A password is required for adding a new user but is optional when updating an existing user.
+          To change a user's password without updating any other fields, use the change password API.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-put-user.html>`_
 
-        :param username: The username of the User
-        :param email:
-        :param enabled:
-        :param full_name:
-        :param metadata:
-        :param password:
-        :param password_hash:
-        :param refresh: If `true` (the default) then refresh the affected shards to make
-            this operation visible to search, if `wait_for` then wait for a refresh to
-            make this operation visible to search, if `false` then do nothing with refreshes.
-        :param roles:
+        :param username: An identifier for the user. NOTE: Usernames must be at least
+            1 and no more than 507 characters. They can contain alphanumeric characters
+            (a-z, A-Z, 0-9), spaces, punctuation, and printable symbols in the Basic
+            Latin (ASCII) block. Leading or trailing whitespace is not allowed.
+        :param email: The email of the user.
+        :param enabled: Specifies whether the user is enabled.
+        :param full_name: The full name of the user.
+        :param metadata: Arbitrary metadata that you want to associate with the user.
+        :param password: The user's password. Passwords must be at least 6 characters
+            long. When adding a user, one of `password` or `password_hash` is required.
+            When updating an existing user, the password is optional, so that other fields
+            on the user (such as their roles) may be updated without modifying the user's
+            password
+        :param password_hash: A hash of the user's password. This must be produced using
+            the same hashing algorithm as has been configured for password storage. For
+            more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm`
+            setting in the user cache and password hash algorithm documentation. Using
+            this parameter allows the client to pre-hash the password for performance
+            and/or confidentiality reasons. The `password` parameter and the `password_hash`
+            parameter cannot be used in the same request.
+        :param refresh: Valid values are `true`, `false`, and `wait_for`. These values
+            have the same meaning as in the index API, but the default value for this
+            API is true.
+        :param roles: A set of roles the user has. The roles determine the user's access
+            permissions. To create a user without any roles, specify an empty list (`[]`).
         """
         if username in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'username'")
@@ -3259,8 +3543,15 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Find API keys with a query. Get a paginated list of API keys and their information.
-        You can optionally filter the results with a query.
+        .. raw:: html
+
+          <p>Find API keys with a query.</p>
+          <p>Get a paginated list of API keys and their information.
+          You can optionally filter the results with a query.</p>
+          <p>To use this API, you must have at least the <code>manage_own_api_key</code> or the <code>read_security</code> cluster privileges.
+          If you have only the <code>manage_own_api_key</code> privilege, this API returns only the API keys that you own.
+          If you have the <code>read_security</code>, <code>manage_api_key</code>, or greater privileges (including <code>manage_security</code>), this API returns all API keys regardless of ownership.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-query-api-key.html>`_
 
@@ -3276,30 +3567,39 @@ class SecurityClient(NamespacedClient):
             `terms`, `range`, `date_range`, `missing`, `cardinality`, `value_count`,
             `composite`, `filter`, and `filters`. Additionally, aggregations only run
             over the same subset of fields that query works with.
-        :param from_: Starting document offset. By default, you cannot page through more
-            than 10,000 hits using the from and size parameters. To page through more
-            hits, use the `search_after` parameter.
+        :param from_: The starting document offset. It must not be negative. By default,
+            you cannot page through more than 10,000 hits using the `from` and `size`
+            parameters. To page through more hits, use the `search_after` parameter.
         :param query: A query to filter which API keys to return. If the query parameter
             is missing, it is equivalent to a `match_all` query. The query supports a
             subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,
             `ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.
             You can query the following public information associated with an API key:
             `id`, `type`, `name`, `creation`, `expiration`, `invalidated`, `invalidation`,
-            `username`, `realm`, and `metadata`.
-        :param search_after: Search after definition
-        :param size: The number of hits to return. By default, you cannot page through
-            more than 10,000 hits using the `from` and `size` parameters. To page through
-            more hits, use the `search_after` parameter.
-        :param sort: Other than `id`, all public fields of an API key are eligible for
-            sorting. In addition, sort can also be applied to the `_doc` field to sort
-            by index order.
+            `username`, `realm`, and `metadata`. NOTE: The queryable string values associated
+            with API keys are internally mapped as keywords. Consequently, if no `analyzer`
+            parameter is specified for a `match` query, then the provided match query
+            string is interpreted as a single keyword value. Such a match query is hence
+            equivalent to a `term` query.
+        :param search_after: The search after definition.
+        :param size: The number of hits to return. It must not be negative. The `size`
+            parameter can be set to `0`, in which case no API key matches are returned,
+            only the aggregation results. By default, you cannot page through more than
+            10,000 hits using the `from` and `size` parameters. To page through more
+            hits, use the `search_after` parameter.
+        :param sort: The sort definition. Other than `id`, all public fields of an API
+            key are eligible for sorting. In addition, sort can also be applied to the
+            `_doc` field to sort by index order.
         :param typed_keys: Determines whether aggregation names are prefixed by their
             respective types in the response.
         :param with_limited_by: Return the snapshot of the owner user's role descriptors
             associated with the API key. An API key's actual permission is the intersection
-            of its assigned role descriptors and the owner user's role descriptors.
-        :param with_profile_uid: Determines whether to also retrieve the profile uid,
-            for the API key owner principal, if it exists.
+            of its assigned role descriptors and the owner user's role descriptors (effectively
+            limited by it). An API key cannot retrieve any API key’s limited-by role
+            descriptors (including itself) unless it has `manage_api_key` or higher privileges.
+        :param with_profile_uid: Determines whether to also retrieve the profile UID
+            for the API key owner principal. If it exists, the profile UID is returned
+            under the `profile_uid` response field for each API key.
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_security/_query/api_key"
@@ -3386,26 +3686,34 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Find roles with a query. Get roles in a paginated manner. You can optionally
-        filter the results with a query.
+        .. raw:: html
+
+          <p>Find roles with a query.</p>
+          <p>Get roles in a paginated manner.
+          The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
+          The query roles API does not retrieve roles that are defined in roles files, nor built-in ones.
+          You can optionally filter the results with a query.
+          Also, the results can be paginated and sorted.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-query-role.html>`_
 
-        :param from_: Starting document offset. By default, you cannot page through more
-            than 10,000 hits using the from and size parameters. To page through more
-            hits, use the `search_after` parameter.
+        :param from_: The starting document offset. It must not be negative. By default,
+            you cannot page through more than 10,000 hits using the `from` and `size`
+            parameters. To page through more hits, use the `search_after` parameter.
         :param query: A query to filter which roles to return. If the query parameter
             is missing, it is equivalent to a `match_all` query. The query supports a
             subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,
             `ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.
             You can query the following information associated with roles: `name`, `description`,
-            `metadata`, `applications.application`, `applications.privileges`, `applications.resources`.
-        :param search_after: Search after definition
-        :param size: The number of hits to return. By default, you cannot page through
-            more than 10,000 hits using the `from` and `size` parameters. To page through
-            more hits, use the `search_after` parameter.
-        :param sort: All public fields of a role are eligible for sorting. In addition,
-            sort can also be applied to the `_doc` field to sort by index order.
+            `metadata`, `applications.application`, `applications.privileges`, and `applications.resources`.
+        :param search_after: The search after definition.
+        :param size: The number of hits to return. It must not be negative. By default,
+            you cannot page through more than 10,000 hits using the `from` and `size`
+            parameters. To page through more hits, use the `search_after` parameter.
+        :param sort: The sort definition. You can sort on `username`, `roles`, or `enabled`.
+            In addition, sort can also be applied to the `_doc` field to sort by index
+            order.
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_security/_query/role"
@@ -3472,28 +3780,35 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Find users with a query. Get information for users in a paginated manner. You
-        can optionally filter the results with a query.
+        .. raw:: html
+
+          <p>Find users with a query.</p>
+          <p>Get information for users in a paginated manner.
+          You can optionally filter the results with a query.</p>
+          <p>NOTE: As opposed to the get user API, built-in users are excluded from the result.
+          This API is only for native users.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-query-user.html>`_
 
-        :param from_: Starting document offset. By default, you cannot page through more
-            than 10,000 hits using the from and size parameters. To page through more
-            hits, use the `search_after` parameter.
+        :param from_: The starting document offset. It must not be negative. By default,
+            you cannot page through more than 10,000 hits using the `from` and `size`
+            parameters. To page through more hits, use the `search_after` parameter.
         :param query: A query to filter which users to return. If the query parameter
             is missing, it is equivalent to a `match_all` query. The query supports a
             subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,
             `ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.
             You can query the following information associated with user: `username`,
-            `roles`, `enabled`
-        :param search_after: Search after definition
-        :param size: The number of hits to return. By default, you cannot page through
-            more than 10,000 hits using the `from` and `size` parameters. To page through
-            more hits, use the `search_after` parameter.
-        :param sort: Fields eligible for sorting are: username, roles, enabled In addition,
-            sort can also be applied to the `_doc` field to sort by index order.
-        :param with_profile_uid: If true will return the User Profile ID for the users
-            in the query result, if any.
+            `roles`, `enabled`, `full_name`, and `email`.
+        :param search_after: The search after definition
+        :param size: The number of hits to return. It must not be negative. By default,
+            you cannot page through more than 10,000 hits using the `from` and `size`
+            parameters. To page through more hits, use the `search_after` parameter.
+        :param sort: The sort definition. Fields eligible for sorting are: `username`,
+            `roles`, `enabled`. In addition, sort can also be applied to the `_doc` field
+            to sort by index order.
+        :param with_profile_uid: Determines whether to retrieve the user profile UID,
+            if it exists, for the users.
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_security/_query/user"
@@ -3551,19 +3866,21 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Authenticate SAML. Submit a SAML response message to Elasticsearch for consumption.
-        NOTE: This API is intended for use by custom web applications other than Kibana.
-        If you are using Kibana, refer to the documentation for configuring SAML single-sign-on
-        on the Elastic Stack. The SAML message that is submitted can be: * A response
-        to a SAML authentication request that was previously created using the SAML prepare
-        authentication API. * An unsolicited SAML message in the case of an IdP-initiated
-        single sign-on (SSO) flow. In either case, the SAML message needs to be a base64
-        encoded XML document with a root element of `<Response>`. After successful validation,
-        Elasticsearch responds with an Elasticsearch internal access token and refresh
-        token that can be subsequently used for authentication. This API endpoint essentially
-        exchanges SAML responses that indicate successful authentication in the IdP for
-        Elasticsearch access and refresh tokens, which can be used for authentication
-        against Elasticsearch.
+        .. raw:: html
+
+          <p>Authenticate SAML.</p>
+          <p>Submit a SAML response message to Elasticsearch for consumption.</p>
+          <p>NOTE: This API is intended for use by custom web applications other than Kibana.
+          If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.</p>
+          <p>The SAML message that is submitted can be:</p>
+          <ul>
+          <li>A response to a SAML authentication request that was previously created using the SAML prepare authentication API.</li>
+          <li>An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow.</li>
+          </ul>
+          <p>In either case, the SAML message needs to be a base64 encoded XML document with a root element of <code>&lt;Response&gt;</code>.</p>
+          <p>After successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.
+          This API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-authenticate.html>`_
 
@@ -3625,16 +3942,18 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Logout of SAML completely. Verifies the logout response sent from the SAML IdP.
-        NOTE: This API is intended for use by custom web applications other than Kibana.
-        If you are using Kibana, refer to the documentation for configuring SAML single-sign-on
-        on the Elastic Stack. The SAML IdP may send a logout response back to the SP
-        after handling the SP-initiated SAML Single Logout. This API verifies the response
-        by ensuring the content is relevant and validating its signature. An empty response
-        is returned if the verification process is successful. The response can be sent
-        by the IdP with either the HTTP-Redirect or the HTTP-Post binding. The caller
-        of this API must prepare the request accordingly so that this API can handle
-        either of them.
+        .. raw:: html
+
+          <p>Logout of SAML completely.</p>
+          <p>Verifies the logout response sent from the SAML IdP.</p>
+          <p>NOTE: This API is intended for use by custom web applications other than Kibana.
+          If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.</p>
+          <p>The SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout.
+          This API verifies the response by ensuring the content is relevant and validating its signature.
+          An empty response is returned if the verification process is successful.
+          The response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding.
+          The caller of this API must prepare the request accordingly so that this API can handle either of them.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-complete-logout.html>`_
 
@@ -3700,15 +4019,17 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Invalidate SAML. Submit a SAML LogoutRequest message to Elasticsearch for consumption.
-        NOTE: This API is intended for use by custom web applications other than Kibana.
-        If you are using Kibana, refer to the documentation for configuring SAML single-sign-on
-        on the Elastic Stack. The logout request comes from the SAML IdP during an IdP
-        initiated Single Logout. The custom web application can use this API to have
-        Elasticsearch process the `LogoutRequest`. After successful validation of the
-        request, Elasticsearch invalidates the access token and refresh token that corresponds
-        to that specific SAML principal and provides a URL that contains a SAML LogoutResponse
-        message. Thus the user can be redirected back to their IdP.
+        .. raw:: html
+
+          <p>Invalidate SAML.</p>
+          <p>Submit a SAML LogoutRequest message to Elasticsearch for consumption.</p>
+          <p>NOTE: This API is intended for use by custom web applications other than Kibana.
+          If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.</p>
+          <p>The logout request comes from the SAML IdP during an IdP initiated Single Logout.
+          The custom web application can use this API to have Elasticsearch process the <code>LogoutRequest</code>.
+          After successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message.
+          Thus the user can be redirected back to their IdP.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-invalidate.html>`_
 
@@ -3775,14 +4096,15 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Logout of SAML. Submits a request to invalidate an access token and refresh token.
-        NOTE: This API is intended for use by custom web applications other than Kibana.
-        If you are using Kibana, refer to the documentation for configuring SAML single-sign-on
-        on the Elastic Stack. This API invalidates the tokens that were generated for
-        a user by the SAML authenticate API. If the SAML realm in Elasticsearch is configured
-        accordingly and the SAML IdP supports this, the Elasticsearch response contains
-        a URL to redirect the user to the IdP that contains a SAML logout request (starting
-        an SP-initiated SAML Single Logout).
+        .. raw:: html
+
+          <p>Logout of SAML.</p>
+          <p>Submits a request to invalidate an access token and refresh token.</p>
+          <p>NOTE: This API is intended for use by custom web applications other than Kibana.
+          If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.</p>
+          <p>This API invalidates the tokens that were generated for a user by the SAML authenticate API.
+          If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-logout.html>`_
 
@@ -3839,20 +4161,20 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Prepare SAML authentication. Create a SAML authentication request (`<AuthnRequest>`)
-        as a URL string based on the configuration of the respective SAML realm in Elasticsearch.
-        NOTE: This API is intended for use by custom web applications other than Kibana.
-        If you are using Kibana, refer to the documentation for configuring SAML single-sign-on
-        on the Elastic Stack. This API returns a URL pointing to the SAML Identity Provider.
-        You can use the URL to redirect the browser of the user in order to continue
-        the authentication process. The URL includes a single parameter named `SAMLRequest`,
-        which contains a SAML Authentication request that is deflated and Base64 encoded.
-        If the configuration dictates that SAML authentication requests should be signed,
-        the URL has two extra parameters named `SigAlg` and `Signature`. These parameters
-        contain the algorithm used for the signature and the signature value itself.
-        It also returns a random string that uniquely identifies this SAML Authentication
-        request. The caller of this API needs to store this identifier as it needs to
-        be used in a following step of the authentication process.
+        .. raw:: html
+
+          <p>Prepare SAML authentication.</p>
+          <p>Create a SAML authentication request (<code>&lt;AuthnRequest&gt;</code>) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.</p>
+          <p>NOTE: This API is intended for use by custom web applications other than Kibana.
+          If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.</p>
+          <p>This API returns a URL pointing to the SAML Identity Provider.
+          You can use the URL to redirect the browser of the user in order to continue the authentication process.
+          The URL includes a single parameter named <code>SAMLRequest</code>, which contains a SAML Authentication request that is deflated and Base64 encoded.
+          If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named <code>SigAlg</code> and <code>Signature</code>.
+          These parameters contain the algorithm used for the signature and the signature value itself.
+          It also returns a random string that uniquely identifies this SAML Authentication request.
+          The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-prepare-authentication.html>`_
 
@@ -3907,11 +4229,13 @@ class SecurityClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create SAML service provider metadata. Generate SAML metadata for a SAML 2.0
-        Service Provider. The SAML 2.0 specification provides a mechanism for Service
-        Providers to describe their capabilities and configuration using a metadata file.
-        This API generates Service Provider metadata based on the configuration of a
-        SAML realm in Elasticsearch.
+        .. raw:: html
+
+          <p>Create SAML service provider metadata.</p>
+          <p>Generate SAML metadata for a SAML 2.0 Service Provider.</p>
+          <p>The SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file.
+          This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-sp-metadata.html>`_
 
@@ -3957,12 +4281,14 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Suggest a user profile. Get suggestions for user profiles that match specified
-        search criteria. NOTE: The user profile feature is designed only for use by Kibana
-        and Elastic's Observability, Enterprise Search, and Elastic Security 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.
+        .. raw:: html
+
+          <p>Suggest a user profile.</p>
+          <p>Get suggestions for user profiles that match specified search criteria.</p>
+          <p>NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security 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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-suggest-user-profile.html>`_
 
@@ -4033,38 +4359,43 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Update an API key. Updates attributes of an existing API key. Users can only
-        update API keys that they created or that were granted to them. Use this API
-        to update API keys created by the create API Key or grant API Key APIs. If you
-        need to apply the same update to many API keys, you can use bulk update API Keys
-        to reduce overhead. It’s not possible to update expired API keys, or API keys
-        that have been invalidated by invalidate API Key. This API supports updates to
-        an API key’s access scope and metadata. The access scope of an API key is derived
-        from the `role_descriptors` you specify in the request, and a snapshot of the
-        owner user’s permissions at the time of the request. The snapshot of the owner’s
-        permissions is updated automatically on every call. If you don’t specify `role_descriptors`
-        in the request, a call to this API might still change the API key’s access scope.
-        This change can occur if the owner user’s permissions have changed since the
-        API key was created or last modified. To update another user’s API key, use the
-        `run_as` feature to submit a request on behalf of another user. IMPORTANT: It’s
-        not possible to use an API key as the authentication credential for this API.
-        To update an API key, the owner user’s credentials are required.
+        .. raw:: html
+
+          <p>Update an API key.</p>
+          <p>Update attributes of an existing API key.
+          This API supports updates to an API key's access scope, expiration, and metadata.</p>
+          <p>To use this API, you must have at least the <code>manage_own_api_key</code> cluster privilege.
+          Users can only update API keys that they created or that were granted to them.
+          To update another user’s API key, use the <code>run_as</code> feature to submit a request on behalf of another user.</p>
+          <p>IMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.</p>
+          <p>Use this API to update API keys created by the create API key or grant API Key APIs.
+          If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.
+          It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.</p>
+          <p>The access scope of an API key is derived from the <code>role_descriptors</code> you specify in the request and a snapshot of the owner user's permissions at the time of the request.
+          The snapshot of the owner's permissions is updated automatically on every call.</p>
+          <p>IMPORTANT: If you don't specify <code>role_descriptors</code> in the request, a call to this API might still change the API key's access scope.
+          This change can occur if the owner user's permissions have changed since the API key was created or last modified.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-update-api-key.html>`_
 
         :param id: The ID of the API key to update.
-        :param expiration: Expiration time for the API key.
+        :param expiration: The expiration time for the API key. By default, API keys
+            never expire. This property can be omitted to leave the expiration unchanged.
         :param metadata: Arbitrary metadata that you want to associate with the API key.
-            It supports nested data structure. Within the metadata object, keys beginning
-            with _ are reserved for system usage.
-        :param role_descriptors: An array of role descriptors for this API key. This
-            parameter is optional. When it is not specified or is an empty array, then
-            the API key will have a point in time snapshot of permissions of the authenticated
-            user. If you supply role descriptors then the resultant permissions would
-            be an intersection of API keys permissions and authenticated user’s permissions
-            thereby limiting the access scope for API keys. The structure of role descriptor
-            is the same as the request for create role API. For more details, see create
-            or update roles API.
+            It supports a nested data structure. Within the metadata object, keys beginning
+            with `_` are reserved for system usage. When specified, this value fully
+            replaces the metadata previously associated with the API key.
+        :param role_descriptors: The role descriptors to assign to this API key. The
+            API key's effective permissions are an intersection of its assigned privileges
+            and the point in time snapshot of permissions of the owner user. You can
+            assign new privileges by specifying them in this parameter. To remove assigned
+            privileges, you can supply an empty `role_descriptors` parameter, that is
+            to say, an empty object `{}`. If an API key has no assigned privileges, it
+            inherits the owner user's full permissions. The snapshot of the owner's permissions
+            is always updated, whether you supply the `role_descriptors` parameter or
+            not. The structure of a role descriptor is the same as the request for the
+            create API keys API.
         """
         if id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'id'")
@@ -4119,19 +4450,20 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Update a cross-cluster API key. Update the attributes of an existing cross-cluster
-        API key, which is used for API key based remote cluster access. To use this API,
-        you must have at least the `manage_security` cluster privilege. Users can only
-        update API keys that they created. To update another user's API key, use the
-        `run_as` feature to submit a request on behalf of another user. IMPORTANT: It's
-        not possible to use an API key as the authentication credential for this API.
-        To update an API key, the owner user's credentials are required. It's not possible
-        to update expired API keys, or API keys that have been invalidated by the invalidate
-        API key API. This API supports updates to an API key's access scope, metadata,
-        and expiration. The owner user's information, such as the `username` and `realm`,
-        is also updated automatically on every call. NOTE: This API cannot update REST
-        API keys, which should be updated by either the update API key or bulk update
-        API keys API.
+        .. raw:: html
+
+          <p>Update a cross-cluster API key.</p>
+          <p>Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.</p>
+          <p>To use this API, you must have at least the <code>manage_security</code> cluster privilege.
+          Users can only update API keys that they created.
+          To update another user's API key, use the <code>run_as</code> feature to submit a request on behalf of another user.</p>
+          <p>IMPORTANT: It's not possible to use an API key as the authentication credential for this API.
+          To update an API key, the owner user's credentials are required.</p>
+          <p>It's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.</p>
+          <p>This API supports updates to an API key's access scope, metadata, and expiration.
+          The owner user's information, such as the <code>username</code> and <code>realm</code>, is also updated automatically on every call.</p>
+          <p>NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-update-cross-cluster-api-key.html>`_
 
@@ -4203,12 +4535,14 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Update security index settings. Update the user-configurable settings for the
-        security internal index (`.security` and associated indices). Only a subset of
-        settings are allowed to be modified, for example `index.auto_expand_replicas`
-        and `index.number_of_replicas`. If a specific index is not in use on the system
-        and settings are provided for it, the request will be rejected. This API does
-        not yet support configuring the settings for indices before they are in use.
+        .. raw:: html
+
+          <p>Update security index settings.</p>
+          <p>Update the user-configurable settings for the security internal index (<code>.security</code> and associated indices). Only a subset of settings are allowed to be modified. This includes <code>index.auto_expand_replicas</code> and <code>index.number_of_replicas</code>.</p>
+          <p>NOTE: If <code>index.auto_expand_replicas</code> is set, <code>index.number_of_replicas</code> will be ignored during updates.</p>
+          <p>If a specific index is not in use on the system and settings are provided for it, the request will be rejected.
+          This API does not yet support configuring the settings for indices before they are in use.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-update-settings.html>`_
 
@@ -4277,19 +4611,23 @@ class SecurityClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Update user profile data. Update specific data for the user profile that is associated
-        with a unique ID. NOTE: The user profile feature is designed only for use by
-        Kibana and Elastic's Observability, Enterprise Search, and Elastic Security 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. To use this API, you must have one of the following privileges:
-        * The `manage_user_profile` cluster privilege. * The `update_profile_data` global
-        privilege for the namespaces that are referenced in the request. This API updates
-        the `labels` and `data` fields of an existing user profile document with JSON
-        objects. New keys and their values are added to the profile document and conflicting
-        keys are replaced by data that's included in the request. For both labels and
-        data, content is namespaced by the top-level fields. The `update_profile_data`
-        global privilege grants privileges for updating only the allowed namespaces.
+        .. raw:: html
+
+          <p>Update user profile data.</p>
+          <p>Update specific data for the user profile that is associated with a unique ID.</p>
+          <p>NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security 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.</p>
+          <p>To use this API, you must have one of the following privileges:</p>
+          <ul>
+          <li>The <code>manage_user_profile</code> cluster privilege.</li>
+          <li>The <code>update_profile_data</code> global privilege for the namespaces that are referenced in the request.</li>
+          </ul>
+          <p>This API updates the <code>labels</code> and <code>data</code> fields of an existing user profile document with JSON objects.
+          New keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.</p>
+          <p>For both labels and data, content is namespaced by the top-level fields.
+          The <code>update_profile_data</code> global privilege grants privileges for updating only the allowed namespaces.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-update-user-profile-data.html>`_