diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 7c402f4911..1f33378924 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -27782,7 +27782,7 @@ "security" ], "summary": "Invalidate API keys", - "description": "Invalidates one or more API keys.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", + "description": "This API invalidates API keys created by the create API key or grant API key APIs.\nInvalidated 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.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- 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.", "operationId": "security-invalidate-api-key", "requestBody": { "content": { @@ -28143,8 +28143,11 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The create or update roles API cannot update roles that are defined in roles files.", + "summary": "Create or update roles", + "description": "The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html" + }, "operationId": "security-put-role", "parameters": [ { @@ -28167,8 +28170,11 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The create or update roles API cannot update roles that are defined in roles files.", + "summary": "Create or update roles", + "description": "The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/defining-roles.html" + }, "operationId": "security-put-role-1", "parameters": [ { @@ -28266,7 +28272,11 @@ "tags": [ "security" ], - "summary": "Creates and updates role mappings", + "summary": "Create or update role mappings", + "description": "Role mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe 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.\n\nThis API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html" + }, "operationId": "security-put-role-mapping", "parameters": [ { @@ -28290,7 +28300,11 @@ "tags": [ "security" ], - "summary": "Creates and updates role mappings", + "summary": "Create or update role mappings", + "description": "Role mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe 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.\n\nThis API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html" + }, "operationId": "security-put-role-mapping-1", "parameters": [ { @@ -28388,8 +28402,8 @@ "tags": [ "security" ], - "summary": "Adds and updates users in the native realm", - "description": "These users are commonly referred to as native users.", + "summary": "Create or update users", + "description": "A password is required for adding a new user but is optional when updating an existing user.\nTo change a user’s password without updating any other fields, use the change password API.", "operationId": "security-put-user", "parameters": [ { @@ -28412,8 +28426,8 @@ "tags": [ "security" ], - "summary": "Adds and updates users in the native realm", - "description": "These users are commonly referred to as native users.", + "summary": "Create or update users", + "description": "A password is required for adding a new user but is optional when updating an existing user.\nTo change a user’s password without updating any other fields, use the change password API.", "operationId": "security-put-user-1", "parameters": [ { @@ -28815,7 +28829,10 @@ "tags": [ "security" ], - "summary": "Adds or updates application privileges", + "summary": "Create or update application privileges", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-put-privileges", "parameters": [ { @@ -28836,7 +28853,10 @@ "tags": [ "security" ], - "summary": "Adds or updates application privileges", + "summary": "Create or update application privileges", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-put-privileges-1", "parameters": [ { @@ -29123,7 +29143,8 @@ "tags": [ "security" ], - "summary": "Invalidates one or more access tokens or refresh tokens", + "summary": "Invalidate a token", + "description": "The access tokens returned by the get token API have a finite period of time for which they are valid.\nAfter that time period, they can no longer be used.\nThe time period is defined by the `xpack.security.authc.token.timeout` setting.\n\nThe refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once.\nIf you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.", "operationId": "security-invalidate-token", "requestBody": { "content": { @@ -29211,7 +29232,7 @@ "tags": [ "security" ], - "summary": "Retrieves security privileges for the logged in user", + "summary": "Get user privileges", "operationId": "security-get-user-privileges", "parameters": [ { @@ -29311,7 +29332,8 @@ "tags": [ "security" ], - "summary": "Retrieves a user's profile using the unique profile ID", + "summary": "Get a user profile", + "description": "Get a user's profile using the unique profile ID.", "operationId": "security-get-user-profile", "parameters": [ { @@ -29390,8 +29412,8 @@ "tags": [ "security" ], - "summary": "Creates an API key on behalf of another user", - "description": "This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API.\nThe 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.\nIt is not possible to use this API to create an API key without that user’s credentials.\nThe user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user.\nIn this case, the API key will be created on behalf of the impersonated user.\n\nThis 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.\n\nA successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.", + "summary": "Grant an API key", + "description": "Create an API key on behalf of another user.\nThis 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.\nThe 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.\nIt is not possible to use this API to create an API key without that user’s credentials.\nThe user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user.\nIn this case, the API key will be created on behalf of the impersonated user.\n\nThis 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.\n\nA successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.", "operationId": "security-grant-api-key", "requestBody": { "content": { @@ -29472,7 +29494,10 @@ "security" ], "summary": "Check user privileges", - "description": "Determines whether the specified user has a specified list of privileges.", + "description": "Determine whether the specified user has a specified list of privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-has-privileges", "requestBody": { "$ref": "#/components/requestBodies/security.has_privileges" @@ -29489,7 +29514,10 @@ "security" ], "summary": "Check user privileges", - "description": "Determines whether the specified user has a specified list of privileges.", + "description": "Determine whether the specified user has a specified list of privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-has-privileges-1", "requestBody": { "$ref": "#/components/requestBodies/security.has_privileges" @@ -29508,7 +29536,10 @@ "security" ], "summary": "Check user privileges", - "description": "Determines whether the specified user has a specified list of privileges.", + "description": "Determine whether the specified user has a specified list of privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-has-privileges-2", "parameters": [ { @@ -29530,7 +29561,10 @@ "security" ], "summary": "Check user privileges", - "description": "Determines whether the specified user has a specified list of privileges.", + "description": "Determine whether the specified user has a specified list of privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-has-privileges-3", "parameters": [ { @@ -29553,7 +29587,11 @@ "tags": [ "security" ], - "summary": "Determines whether the users associated with the specified profile IDs have all the requested privileges", + "summary": "Check user profile privileges", + "description": "Determine whether the users associated with the specified user profile IDs have all the requested privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/user-profile.html" + }, "operationId": "security-has-privileges-user-profile", "requestBody": { "$ref": "#/components/requestBodies/security.has_privileges_user_profile" @@ -29569,7 +29607,11 @@ "tags": [ "security" ], - "summary": "Determines whether the users associated with the specified profile IDs have all the requested privileges", + "summary": "Check user profile privileges", + "description": "Determine whether the users associated with the specified user profile IDs have all the requested privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/user-profile.html" + }, "operationId": "security-has-privileges-user-profile-1", "requestBody": { "$ref": "#/components/requestBodies/security.has_privileges_user_profile" @@ -29587,8 +29629,8 @@ "tags": [ "security" ], - "summary": "Query API keys", - "description": "Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", + "summary": "Find API keys with a query", + "description": "Get a paginated list of API keys and their information. You can optionally filter the results with a query.", "operationId": "security-query-api-keys", "parameters": [ { @@ -29615,8 +29657,8 @@ "tags": [ "security" ], - "summary": "Query API keys", - "description": "Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", + "summary": "Find API keys with a query", + "description": "Get a paginated list of API keys and their information. You can optionally filter the results with a query.", "operationId": "security-query-api-keys-1", "parameters": [ { @@ -29645,8 +29687,8 @@ "tags": [ "security" ], - "summary": "Retrieves roles in a paginated manner", - "description": "You can optionally filter the results with a query.", + "summary": "Find roles with a query", + "description": "Get roles in a paginated manner. You can optionally filter the results with a query.", "operationId": "security-query-role", "requestBody": { "$ref": "#/components/requestBodies/security.query_role" @@ -29662,8 +29704,8 @@ "tags": [ "security" ], - "summary": "Retrieves roles in a paginated manner", - "description": "You can optionally filter the results with a query.", + "summary": "Find roles with a query", + "description": "Get roles in a paginated manner. You can optionally filter the results with a query.", "operationId": "security-query-role-1", "requestBody": { "$ref": "#/components/requestBodies/security.query_role" @@ -29681,8 +29723,8 @@ "tags": [ "security" ], - "summary": "Retrieves information for Users in a paginated manner", - "description": "You can optionally filter the results with a query.", + "summary": "Find users with a query", + "description": "Get information for users in a paginated manner.\nYou can optionally filter the results with a query.", "operationId": "security-query-user", "parameters": [ { @@ -29703,8 +29745,8 @@ "tags": [ "security" ], - "summary": "Retrieves information for Users in a paginated manner", - "description": "You can optionally filter the results with a query.", + "summary": "Find users with a query", + "description": "Get information for users in a paginated manner.\nYou can optionally filter the results with a query.", "operationId": "security-query-user-1", "parameters": [ { @@ -29727,7 +29769,8 @@ "tags": [ "security" ], - "summary": "Submits a SAML Response message to Elasticsearch for consumption", + "summary": "Authenticate SAML", + "description": "Submits a SAML response message to Elasticsearch for consumption.", "operationId": "security-saml-authenticate", "requestBody": { "content": { @@ -29800,7 +29843,8 @@ "tags": [ "security" ], - "summary": "Verifies the logout response sent from the SAML IdP", + "summary": "Logout of SAML completely", + "description": "Verifies the logout response sent from the SAML IdP.", "operationId": "security-saml-complete-logout", "requestBody": { "content": { @@ -29849,7 +29893,8 @@ "tags": [ "security" ], - "summary": "Submits a SAML LogoutRequest message to Elasticsearch for consumption", + "summary": "Invalidate SAML", + "description": "Submits a SAML LogoutRequest message to Elasticsearch for consumption.", "operationId": "security-saml-invalidate", "requestBody": { "content": { @@ -29914,7 +29959,8 @@ "tags": [ "security" ], - "summary": "Submits a request to invalidate an access token and refresh token", + "summary": "Logout of SAML", + "description": "Submits a request to invalidate an access token and refresh token.", "operationId": "security-saml-logout", "requestBody": { "content": { @@ -29967,7 +30013,8 @@ "tags": [ "security" ], - "summary": "Creates a SAML authentication request () as a URL string, based on the configuration of the respective SAML realm in Elasticsearch", + "summary": "Prepare SAML authentication", + "description": "Creates a SAML authentication request (``) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.", "operationId": "security-saml-prepare-authentication", "requestBody": { "content": { @@ -30029,7 +30076,8 @@ "tags": [ "security" ], - "summary": "Generate SAML metadata for a SAML 2.0 Service Provider", + "summary": "Create SAML service provider metadata", + "description": "Generate SAML metadata for a SAML 2.0 Service Provider.", "operationId": "security-saml-service-provider-metadata", "parameters": [ { @@ -30072,7 +30120,8 @@ "tags": [ "security" ], - "summary": "Get suggestions for user profiles that match specified search criteria", + "summary": "Suggest a user profile", + "description": "Get suggestions for user profiles that match specified search criteria.", "operationId": "security-suggest-user-profiles", "parameters": [ { @@ -30093,7 +30142,8 @@ "tags": [ "security" ], - "summary": "Get suggestions for user profiles that match specified search criteria", + "summary": "Suggest a user profile", + "description": "Get suggestions for user profiles that match specified search criteria.", "operationId": "security-suggest-user-profiles-1", "parameters": [ { @@ -30185,7 +30235,8 @@ "tags": [ "security" ], - "summary": "Updates specific data for the user profile that's associated with the specified unique ID", + "summary": "Update user profile data", + "description": "Update specific data for the user profile that is associated with a unique ID.", "operationId": "security-update-user-profile-data", "parameters": [ { @@ -30215,7 +30266,8 @@ "tags": [ "security" ], - "summary": "Updates specific data for the user profile that's associated with the specified unique ID", + "summary": "Update user profile data", + "description": "Update specific data for the user profile that is associated with a unique ID.", "operationId": "security-update-user-profile-data-1", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 1105c62353..98d69ea026 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -17120,7 +17120,7 @@ "security" ], "summary": "Invalidate API keys", - "description": "Invalidates one or more API keys.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", + "description": "This API invalidates API keys created by the create API key or grant API key APIs.\nInvalidated 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.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- 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.", "operationId": "security-invalidate-api-key", "requestBody": { "content": { @@ -17207,7 +17207,10 @@ "security" ], "summary": "Check user privileges", - "description": "Determines whether the specified user has a specified list of privileges.", + "description": "Determine whether the specified user has a specified list of privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-has-privileges", "requestBody": { "$ref": "#/components/requestBodies/security.has_privileges" @@ -17224,7 +17227,10 @@ "security" ], "summary": "Check user privileges", - "description": "Determines whether the specified user has a specified list of privileges.", + "description": "Determine whether the specified user has a specified list of privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-has-privileges-1", "requestBody": { "$ref": "#/components/requestBodies/security.has_privileges" @@ -17243,7 +17249,10 @@ "security" ], "summary": "Check user privileges", - "description": "Determines whether the specified user has a specified list of privileges.", + "description": "Determine whether the specified user has a specified list of privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-has-privileges-2", "parameters": [ { @@ -17265,7 +17274,10 @@ "security" ], "summary": "Check user privileges", - "description": "Determines whether the specified user has a specified list of privileges.", + "description": "Determine whether the specified user has a specified list of privileges.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-has-privileges-3", "parameters": [ { @@ -17288,8 +17300,8 @@ "tags": [ "security" ], - "summary": "Query API keys", - "description": "Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", + "summary": "Find API keys with a query", + "description": "Get a paginated list of API keys and their information. You can optionally filter the results with a query.", "operationId": "security-query-api-keys", "parameters": [ { @@ -17316,8 +17328,8 @@ "tags": [ "security" ], - "summary": "Query API keys", - "description": "Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", + "summary": "Find API keys with a query", + "description": "Get a paginated list of API keys and their information. You can optionally filter the results with a query.", "operationId": "security-query-api-keys-1", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 614cd71396..5ed8c3e768 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -16346,7 +16346,7 @@ "stability": "stable" } }, - "description": "Retrieves security privileges for the logged in user.", + "description": "Get user privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html", "name": "security.get_user_privileges", "request": { @@ -16381,7 +16381,7 @@ "stability": "stable" } }, - "description": "Retrieves a user's profile using the unique profile ID.", + "description": "Get a user profile.\n\nGet a user's profile using the unique profile ID.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-profile.html", "name": "security.get_user_profile", "privileges": { @@ -16421,7 +16421,7 @@ "stability": "stable" } }, - "description": "Creates an API key on behalf of another user.\nThis API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API.\nThe 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.\nIt is not possible to use this API to create an API key without that user’s credentials.\nThe user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user.\nIn this case, the API key will be created on behalf of the impersonated user.\n\nThis 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.\n\nA successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Grant an API key.\n\nCreate an API key on behalf of another user.\nThis 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.\nThe 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.\nIt is not possible to use this API to create an API key without that user’s credentials.\nThe user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user.\nIn this case, the API key will be created on behalf of the impersonated user.\n\nThis 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.\n\nA successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html", "name": "security.grant_api_key", "privileges": { @@ -16464,8 +16464,10 @@ "stability": "stable" } }, - "description": "Check user privileges.\nDetermines whether the specified user has a specified list of privileges.", + "description": "Check user privileges.\n\nDetermine whether the specified user has a specified list of privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html", + "extDocId": "security-privileges", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.has_privileges", "request": { "name": "Request", @@ -16510,8 +16512,10 @@ "stability": "stable" } }, - "description": "Determines whether the users associated with the specified profile IDs have all the requested privileges.", + "description": "Check user profile privileges.\n\nDetermine whether the users associated with the specified user profile IDs have all the requested privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges-user-profile.html", + "extDocId": "user-profile", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/user-profile.html", "name": "security.has_privileges_user_profile", "privileges": { "cluster": [ @@ -16554,7 +16558,7 @@ "stability": "stable" } }, - "description": "Invalidate API keys.\nInvalidates one or more API keys.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", + "description": "Invalidate API keys.\n\nThis API invalidates API keys created by the create API key or grant API key APIs.\nInvalidated 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.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- 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.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html", "name": "security.invalidate_api_key", "privileges": { @@ -16598,7 +16602,7 @@ "stability": "stable" } }, - "description": "Invalidates one or more access tokens or refresh tokens.", + "description": "Invalidate a token.\n\nThe access tokens returned by the get token API have a finite period of time for which they are valid.\nAfter that time period, they can no longer be used.\nThe time period is defined by the `xpack.security.authc.token.timeout` setting.\n\nThe refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once.\nIf you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html", "name": "security.invalidate_token", "request": { @@ -16720,8 +16724,10 @@ "stability": "stable" } }, - "description": "Adds or updates application privileges.", + "description": "Create or update application privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html", + "extDocId": "security-privileges", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.put_privileges", "request": { "name": "Request", @@ -16758,8 +16764,10 @@ "stability": "stable" } }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.", + "description": "Create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html", + "extDocId": "defining-roles", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/defining-roles.html", "name": "security.put_role", "privileges": { "cluster": [ @@ -16802,8 +16810,10 @@ "stability": "stable" } }, - "description": "Creates and updates role mappings.", + "description": "Create or update role mappings.\n\nRole mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe 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.\n\nThis API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html", + "extDocId": "mapping-roles", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html", "name": "security.put_role_mapping", "request": { "name": "Request", @@ -16836,7 +16846,7 @@ "stability": "stable" } }, - "description": "Adds and updates users in the native realm. These users are commonly referred to as native users.", + "description": "Create or update users.\n\nA password is required for adding a new user but is optional when updating an existing user.\nTo change a user’s password without updating any other fields, use the change password API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html", "name": "security.put_user", "request": { @@ -16875,7 +16885,7 @@ "stability": "stable" } }, - "description": "Query API keys.\nRetrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", + "description": "Find API keys with a query.\n\nGet a paginated list of API keys and their information. You can optionally filter the results with a query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html", "name": "security.query_api_keys", "privileges": { @@ -16920,7 +16930,7 @@ "stability": "stable" } }, - "description": "Retrieves roles in a paginated manner. You can optionally filter the results with a query.", + "description": "Find roles with a query.\n\nGet roles in a paginated manner. You can optionally filter the results with a query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-role.html", "name": "security.query_role", "privileges": { @@ -16964,7 +16974,7 @@ "stability": "stable" } }, - "description": "Retrieves information for Users in a paginated manner. You can optionally filter the results with a query.", + "description": "Find users with a query.\n\nGet information for users in a paginated manner.\nYou can optionally filter the results with a query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html", "name": "security.query_user", "privileges": { @@ -17008,7 +17018,7 @@ "stability": "stable" } }, - "description": "Submits a SAML Response message to Elasticsearch for consumption.", + "description": "Authenticate SAML.\n\nSubmits a SAML response message to Elasticsearch for consumption.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html", "name": "security.saml_authenticate", "request": { @@ -17046,7 +17056,7 @@ "stability": "stable" } }, - "description": "Verifies the logout response sent from the SAML IdP.", + "description": "Logout of SAML completely.\n\nVerifies the logout response sent from the SAML IdP.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html", "name": "security.saml_complete_logout", "request": { @@ -17084,7 +17094,7 @@ "stability": "stable" } }, - "description": "Submits a SAML LogoutRequest message to Elasticsearch for consumption.", + "description": "Invalidate SAML.\n\nSubmits a SAML LogoutRequest message to Elasticsearch for consumption.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html", "name": "security.saml_invalidate", "request": { @@ -17122,7 +17132,7 @@ "stability": "stable" } }, - "description": "Submits a request to invalidate an access token and refresh token.", + "description": "Logout of SAML.\n\nSubmits a request to invalidate an access token and refresh token.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html", "name": "security.saml_logout", "request": { @@ -17160,7 +17170,7 @@ "stability": "stable" } }, - "description": "Creates a SAML authentication request () as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.", + "description": "Prepare SAML authentication.\n\nCreates a SAML authentication request (``) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html", "name": "security.saml_prepare_authentication", "request": { @@ -17198,7 +17208,7 @@ "stability": "stable" } }, - "description": "Generate SAML metadata for a SAML 2.0 Service Provider.", + "description": "Create SAML service provider metadata.\n\nGenerate SAML metadata for a SAML 2.0 Service Provider.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html", "name": "security.saml_service_provider_metadata", "request": { @@ -17236,7 +17246,7 @@ "stability": "stable" } }, - "description": "Get suggestions for user profiles that match specified search criteria.", + "description": "Suggest a user profile.\n\nGet suggestions for user profiles that match specified search criteria.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-suggest-user-profile.html", "name": "security.suggest_user_profiles", "request": { @@ -17275,7 +17285,7 @@ "stability": "stable" } }, - "description": "Update an API key.\nUpdates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe 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.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", + "description": "Update an API key.\n\nUpdates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe 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.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html", "name": "security.update_api_key", "privileges": { @@ -17374,7 +17384,7 @@ "stability": "stable" } }, - "description": "Updates specific data for the user profile that's associated with the specified unique ID.", + "description": "Update user profile data.\n\nUpdate specific data for the user profile that is associated with a unique ID.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-user-profile-data.html", "name": "security.update_user_profile_data", "privileges": { @@ -192177,7 +192187,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves security privileges for the logged in user.", + "description": "Get user privileges.", "inherits": { "type": { "name": "RequestBase", @@ -192238,7 +192248,7 @@ } } ], - "specLocation": "security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts#L23-L36" + "specLocation": "security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts#L23-L37" }, { "kind": "response", @@ -192374,7 +192384,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a user's profile using the unique profile ID.", + "description": "Get a user profile.\n\nGet a user's profile using the unique profile ID.", "inherits": { "type": { "name": "RequestBase", @@ -192443,7 +192453,7 @@ } } ], - "specLocation": "security/get_user_profile/Request.ts#L23-L46" + "specLocation": "security/get_user_profile/Request.ts#L23-L48" }, { "kind": "response", @@ -192675,7 +192685,7 @@ } ] }, - "description": "Creates an API key on behalf of another user.\nThis API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API.\nThe 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.\nIt is not possible to use this API to create an API key without that user’s credentials.\nThe user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user.\nIn this case, the API key will be created on behalf of the impersonated user.\n\nThis 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.\n\nA successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Grant an API key.\n\nCreate an API key on behalf of another user.\nThis 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.\nThe 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.\nIt is not possible to use this API to create an API key without that user’s credentials.\nThe user, for whom the authentication credentials is provided, can optionally \"run as\" (impersonate) another user.\nIn this case, the API key will be created on behalf of the impersonated user.\n\nThis 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.\n\nA successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.", "inherits": { "type": { "name": "RequestBase", @@ -192688,7 +192698,7 @@ }, "path": [], "query": [], - "specLocation": "security/grant_api_key/SecurityGrantApiKeyRequest.ts#L24-L75" + "specLocation": "security/grant_api_key/SecurityGrantApiKeyRequest.ts#L24-L77" }, { "kind": "response", @@ -192973,7 +192983,7 @@ } ] }, - "description": "Check user privileges.\nDetermines whether the specified user has a specified list of privileges.", + "description": "Check user privileges.\n\nDetermine whether the specified user has a specified list of privileges.", "inherits": { "type": { "name": "RequestBase", @@ -192999,7 +193009,7 @@ } ], "query": [], - "specLocation": "security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L44" + "specLocation": "security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L46" }, { "kind": "type_alias", @@ -193249,7 +193259,7 @@ } ] }, - "description": "Determines whether the users associated with the specified profile IDs have all the requested privileges.", + "description": "Check user profile privileges.\n\nDetermine whether the users associated with the specified user profile IDs have all the requested privileges.", "inherits": { "type": { "name": "RequestBase", @@ -193262,7 +193272,7 @@ }, "path": [], "query": [], - "specLocation": "security/has_privileges_user_profile/Request.ts#L24-L38" + "specLocation": "security/has_privileges_user_profile/Request.ts#L24-L42" }, { "kind": "response", @@ -193389,7 +193399,7 @@ } ] }, - "description": "Invalidate API keys.\nInvalidates one or more API keys.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- Or, if the request is issued by an API key, i.e. an API key invalidates itself, specify its ID in the `ids` field.", + "description": "Invalidate API keys.\n\nThis API invalidates API keys created by the create API key or grant API key APIs.\nInvalidated 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.\nThe `manage_api_key` privilege allows deleting any API keys.\nThe `manage_own_api_key` only allows deleting API keys that are owned by the user.\nIn addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:\n- Set the parameter `owner=true`.\n- Or, set both `username` and `realm_name` to match the user’s identity.\n- 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.", "inherits": { "type": { "name": "RequestBase", @@ -193402,7 +193412,7 @@ }, "path": [], "query": [], - "specLocation": "security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts#L23-L67" + "specLocation": "security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts#L23-L69" }, { "kind": "response", @@ -193524,7 +193534,7 @@ } ] }, - "description": "Invalidates one or more access tokens or refresh tokens.", + "description": "Invalidate a token.\n\nThe access tokens returned by the get token API have a finite period of time for which they are valid.\nAfter that time period, they can no longer be used.\nThe time period is defined by the `xpack.security.authc.token.timeout` setting.\n\nThe refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once.\nIf you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.", "inherits": { "type": { "name": "RequestBase", @@ -193537,7 +193547,7 @@ }, "path": [], "query": [], - "specLocation": "security/invalidate_token/SecurityInvalidateTokenRequest.ts#L23-L35" + "specLocation": "security/invalidate_token/SecurityInvalidateTokenRequest.ts#L23-L43" }, { "kind": "response", @@ -193694,7 +193704,7 @@ } } }, - "description": "Adds or updates application privileges.", + "description": "Create or update application privileges.", "inherits": { "type": { "name": "RequestBase", @@ -193720,7 +193730,7 @@ } } ], - "specLocation": "security/put_privileges/SecurityPutPrivilegesRequest.ts#L25-L37" + "specLocation": "security/put_privileges/SecurityPutPrivilegesRequest.ts#L25-L38" }, { "kind": "response", @@ -193919,7 +193929,7 @@ } ] }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.", + "description": "Create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless.", "inherits": { "type": { "name": "RequestBase", @@ -193958,7 +193968,7 @@ } } ], - "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L91" + "specLocation": "security/put_role/SecurityPutRoleRequest.ts#L31-L95" }, { "kind": "response", @@ -194069,7 +194079,7 @@ } ] }, - "description": "Creates and updates role mappings.", + "description": "Create or update role mappings.\n\nRole mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe 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.\n\nThis API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.", "inherits": { "type": { "name": "RequestBase", @@ -194108,7 +194118,7 @@ } } ], - "specLocation": "security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L25-L47" + "specLocation": "security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L25-L56" }, { "kind": "response", @@ -194270,7 +194280,7 @@ } ] }, - "description": "Adds and updates users in the native realm. These users are commonly referred to as native users.", + "description": "Create or update users.\n\nA password is required for adding a new user but is optional when updating an existing user.\nTo change a user’s password without updating any other fields, use the change password API.", "inherits": { "type": { "name": "RequestBase", @@ -194309,7 +194319,7 @@ } } ], - "specLocation": "security/put_user/SecurityPutUserRequest.ts#L23-L44" + "specLocation": "security/put_user/SecurityPutUserRequest.ts#L23-L48" }, { "kind": "response", @@ -195015,7 +195025,7 @@ } ] }, - "description": "Query API keys.\nRetrieves a paginated list of API keys and their information. You can optionally filter the results with a query.", + "description": "Find API keys with a query.\n\nGet a paginated list of API keys and their information. You can optionally filter the results with a query.", "inherits": { "type": { "name": "RequestBase", @@ -195085,7 +195095,7 @@ } } ], - "specLocation": "security/query_api_keys/QueryApiKeysRequest.ts#L26-L100" + "specLocation": "security/query_api_keys/QueryApiKeysRequest.ts#L26-L101" }, { "kind": "response", @@ -195275,7 +195285,7 @@ } ] }, - "description": "Retrieves roles in a paginated manner. You can optionally filter the results with a query.", + "description": "Find roles with a query.\n\nGet roles in a paginated manner. You can optionally filter the results with a query.", "inherits": { "type": { "name": "RequestBase", @@ -195288,7 +195298,7 @@ }, "path": [], "query": [], - "specLocation": "security/query_role/QueryRolesRequest.ts#L25-L67" + "specLocation": "security/query_role/QueryRolesRequest.ts#L25-L69" }, { "kind": "response", @@ -195666,7 +195676,7 @@ } ] }, - "description": "Retrieves information for Users in a paginated manner. You can optionally filter the results with a query.", + "description": "Find users with a query.\n\nGet information for users in a paginated manner.\nYou can optionally filter the results with a query.", "inherits": { "type": { "name": "RequestBase", @@ -195692,7 +195702,7 @@ } } ], - "specLocation": "security/query_user/SecurityQueryUserRequest.ts#L25-L72" + "specLocation": "security/query_user/SecurityQueryUserRequest.ts#L25-L75" }, { "kind": "response", @@ -196015,7 +196025,7 @@ } ] }, - "description": "Submits a SAML Response message to Elasticsearch for consumption.", + "description": "Authenticate SAML.\n\nSubmits a SAML response message to Elasticsearch for consumption.", "inherits": { "type": { "name": "RequestBase", @@ -196028,7 +196038,7 @@ }, "path": [], "query": [], - "specLocation": "security/saml_authenticate/Request.ts#L23-L38" + "specLocation": "security/saml_authenticate/Request.ts#L23-L40" }, { "kind": "response", @@ -196156,7 +196166,7 @@ } ] }, - "description": "Verifies the logout response sent from the SAML IdP.", + "description": "Logout of SAML completely.\n\nVerifies the logout response sent from the SAML IdP.", "inherits": { "type": { "name": "RequestBase", @@ -196169,7 +196179,7 @@ }, "path": [], "query": [], - "specLocation": "security/saml_complete_logout/Request.ts#L23-L40" + "specLocation": "security/saml_complete_logout/Request.ts#L23-L42" }, { "kind": "response", @@ -196228,7 +196238,7 @@ } ] }, - "description": "Submits a SAML LogoutRequest message to Elasticsearch for consumption.", + "description": "Invalidate SAML.\n\nSubmits a SAML LogoutRequest message to Elasticsearch for consumption.", "inherits": { "type": { "name": "RequestBase", @@ -196241,7 +196251,7 @@ }, "path": [], "query": [], - "specLocation": "security/saml_invalidate/Request.ts#L22-L43" + "specLocation": "security/saml_invalidate/Request.ts#L22-L45" }, { "kind": "response", @@ -196323,7 +196333,7 @@ } ] }, - "description": "Submits a request to invalidate an access token and refresh token.", + "description": "Logout of SAML.\n\nSubmits a request to invalidate an access token and refresh token.", "inherits": { "type": { "name": "RequestBase", @@ -196336,7 +196346,7 @@ }, "path": [], "query": [], - "specLocation": "security/saml_logout/Request.ts#L22-L41" + "specLocation": "security/saml_logout/Request.ts#L22-L43" }, { "kind": "response", @@ -196408,7 +196418,7 @@ } ] }, - "description": "Creates a SAML authentication request () as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.", + "description": "Prepare SAML authentication.\n\nCreates a SAML authentication request (``) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -196421,7 +196431,7 @@ }, "path": [], "query": [], - "specLocation": "security/saml_prepare_authentication/Request.ts#L22-L46" + "specLocation": "security/saml_prepare_authentication/Request.ts#L22-L48" }, { "kind": "response", @@ -196477,7 +196487,7 @@ "body": { "kind": "no_body" }, - "description": "Generate SAML metadata for a SAML 2.0 Service Provider.", + "description": "Create SAML service provider metadata.\n\nGenerate SAML metadata for a SAML 2.0 Service Provider.", "inherits": { "type": { "name": "RequestBase", @@ -196503,7 +196513,7 @@ } ], "query": [], - "specLocation": "security/saml_service_provider_metadata/Request.ts#L23-L34" + "specLocation": "security/saml_service_provider_metadata/Request.ts#L23-L36" }, { "kind": "response", @@ -196666,7 +196676,7 @@ } ] }, - "description": "Get suggestions for user profiles that match specified search criteria.", + "description": "Suggest a user profile.\n\nGet suggestions for user profiles that match specified search criteria.", "inherits": { "type": { "name": "RequestBase", @@ -196707,7 +196717,7 @@ } } ], - "specLocation": "security/suggest_user_profiles/Request.ts#L24-L66" + "specLocation": "security/suggest_user_profiles/Request.ts#L24-L68" }, { "kind": "response", @@ -196849,7 +196859,7 @@ } ] }, - "description": "Update an API key.\nUpdates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe 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.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", + "description": "Update an API key.\n\nUpdates attributes of an existing API key.\nUsers can only update API keys that they created or that were granted to them.\nUse this API to update API keys created by the create API Key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead.\nIt’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key.\nThis API supports updates to an API key’s access scope and metadata.\nThe 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.\nThe snapshot of the owner’s permissions is updated automatically on every call.\nIf you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope.\nThis change can occur if the owner user’s permissions have changed since the API key was created or last modified.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\nIMPORTANT: It’s not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user’s credentials are required.", "inherits": { "type": { "name": "RequestBase", @@ -196875,7 +196885,7 @@ } ], "query": [], - "specLocation": "security/update_api_key/Request.ts#L26-L66" + "specLocation": "security/update_api_key/Request.ts#L26-L67" }, { "kind": "response", @@ -196950,7 +196960,7 @@ } ] }, - "description": "Updates specific data for the user profile that's associated with the specified unique ID.", + "description": "Update user profile data.\n\nUpdate specific data for the user profile that is associated with a unique ID.", "inherits": { "type": { "name": "RequestBase", @@ -197014,7 +197024,7 @@ } } ], - "specLocation": "security/update_user_profile_data/Request.ts#L27-L70" + "specLocation": "security/update_user_profile_data/Request.ts#L27-L72" }, { "kind": "response", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 823f4d83ab..a534c32bca 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -112,6 +112,7 @@ data-stream-path-param,https://www.elastic.co/guide/en/elasticsearch/reference/{ data-streams,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams.html date-index-name-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-index-name-processor.html dcg,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_discounted_cumulative_gain_dcg +defining-roles,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/defining-roles.html delete-async-sql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-async-sql-search-api.html delete-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-enrich-policy-api.html delete-license,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-license.html @@ -621,6 +622,7 @@ uppercase-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{bra urldecode-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/urldecode-processor.html usage-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/usage-api.html user-agent-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/user-agent-processor.html +user-profile,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/user-profile.html voting-config-exclusions,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/voting-config-exclusions.html watcher-api-ack-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-ack-watch.html watcher-api-activate-watch,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/watcher-api-activate-watch.html diff --git a/specification/security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts b/specification/security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts index 07c3d9a54b..a549b6f186 100644 --- a/specification/security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts +++ b/specification/security/get_user_privileges/SecurityGetUserPrivilegesRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Get user privileges. * @rest_spec_name security.get_user_privileges * @availability stack since=6.5.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/get_user_profile/Request.ts b/specification/security/get_user_profile/Request.ts index b65916328a..81cd5a3a6a 100644 --- a/specification/security/get_user_profile/Request.ts +++ b/specification/security/get_user_profile/Request.ts @@ -21,7 +21,9 @@ import { UserProfileId } from '@security/_types/UserProfile' import { RequestBase } from '@_types/Base' /** - * Retrieves a user's profile using the unique profile ID. + * Get a user profile. + * + * Get a user's profile using the unique profile ID. * @rest_spec_name security.get_user_profile * @availability stack since=8.2.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/grant_api_key/SecurityGrantApiKeyRequest.ts b/specification/security/grant_api_key/SecurityGrantApiKeyRequest.ts index 60690cc003..30e7478208 100644 --- a/specification/security/grant_api_key/SecurityGrantApiKeyRequest.ts +++ b/specification/security/grant_api_key/SecurityGrantApiKeyRequest.ts @@ -22,8 +22,10 @@ import { Password, Username } from '@_types/common' import { ApiKeyGrantType, GrantApiKey } from './types' /** - * Creates an API key on behalf of another user. - * This API is similar to Create API keys, however it creates the API key for a user that is different than the user that runs the API. + * 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. diff --git a/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts b/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts index ee25210b71..560746e548 100644 --- a/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts +++ b/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts @@ -24,10 +24,12 @@ import { ApplicationPrivilegesCheck, IndexPrivilegesCheck } from './types' /** * Check user privileges. - * Determines whether the specified user has a specified list of privileges. + * + * Determine whether the specified user has a specified list of privileges. * @rest_spec_name security.has_privileges * @availability stack since=6.4.0 stability=stable * @availability serverless stability=stable visibility=public + * @ext_doc_id security-privileges */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/has_privileges_user_profile/Request.ts b/specification/security/has_privileges_user_profile/Request.ts index d8487d4c1c..7f6a6d4eaf 100644 --- a/specification/security/has_privileges_user_profile/Request.ts +++ b/specification/security/has_privileges_user_profile/Request.ts @@ -22,10 +22,14 @@ import { RequestBase } from '@_types/Base' import { PrivilegesCheck } from './types' /** + * Check user profile privileges. + * + * Determine whether the users associated with the specified user profile IDs have all the requested privileges. * @rest_spec_name security.has_privileges_user_profile * @availability stack since=8.3.0 stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges manage_user_profile + * @ext_doc_id user-profile */ export interface Request extends RequestBase { body: { diff --git a/specification/security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts b/specification/security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts index 438ce35765..96c1f01c20 100644 --- a/specification/security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts +++ b/specification/security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts @@ -22,13 +22,15 @@ import { Id, Name, Username } from '@_types/common' /** * Invalidate API keys. - * Invalidates one or more 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, i.e. an API key invalidates itself, specify its ID in the `ids` field. + * - 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. * @rest_spec_name security.invalidate_api_key * @availability stack since=6.7.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/security/invalidate_token/SecurityInvalidateTokenRequest.ts b/specification/security/invalidate_token/SecurityInvalidateTokenRequest.ts index 0a7f71ef03..0e1ef59e2a 100644 --- a/specification/security/invalidate_token/SecurityInvalidateTokenRequest.ts +++ b/specification/security/invalidate_token/SecurityInvalidateTokenRequest.ts @@ -21,6 +21,14 @@ import { RequestBase } from '@_types/Base' import { Name, Username } from '@_types/common' /** + * 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. * @rest_spec_name security.invalidate_token * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/put_privileges/SecurityPutPrivilegesRequest.ts b/specification/security/put_privileges/SecurityPutPrivilegesRequest.ts index ea5414d537..90c7694e46 100644 --- a/specification/security/put_privileges/SecurityPutPrivilegesRequest.ts +++ b/specification/security/put_privileges/SecurityPutPrivilegesRequest.ts @@ -23,10 +23,11 @@ import { Refresh } from '@_types/common' import { Actions } from './types' /** + * Create or update application privileges. * @rest_spec_name security.put_privileges * @availability stack since=6.4.0 stability=stable * @availability serverless stability=stable visibility=private - * + * @ext_doc_id security-privileges */ export interface Request extends RequestBase { query_parameters: { diff --git a/specification/security/put_role/SecurityPutRoleRequest.ts b/specification/security/put_role/SecurityPutRoleRequest.ts index bfe818361f..3aa4f673e8 100644 --- a/specification/security/put_role/SecurityPutRoleRequest.ts +++ b/specification/security/put_role/SecurityPutRoleRequest.ts @@ -29,12 +29,16 @@ import { RequestBase } from '@_types/Base' import { Metadata, Name, Refresh } from '@_types/common' /** - * The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + * 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. * @rest_spec_name security.put_role * @availability stack stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges manage_security + * @ext_doc_id defining-roles */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/put_role_mapping/SecurityPutRoleMappingRequest.ts b/specification/security/put_role_mapping/SecurityPutRoleMappingRequest.ts index 2ad9aba1e1..4061546c0e 100644 --- a/specification/security/put_role_mapping/SecurityPutRoleMappingRequest.ts +++ b/specification/security/put_role_mapping/SecurityPutRoleMappingRequest.ts @@ -23,9 +23,18 @@ import { RequestBase } from '@_types/Base' import { Metadata, Name, Refresh } from '@_types/common' /** + * 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. * @rest_spec_name security.put_role_mapping * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=private + * @ext_doc_id mapping-roles */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/put_user/SecurityPutUserRequest.ts b/specification/security/put_user/SecurityPutUserRequest.ts index ada08b3c16..7e366a6983 100644 --- a/specification/security/put_user/SecurityPutUserRequest.ts +++ b/specification/security/put_user/SecurityPutUserRequest.ts @@ -21,6 +21,10 @@ import { RequestBase } from '@_types/Base' import { Metadata, Password, Refresh, Username } from '@_types/common' /** + * 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. * @rest_spec_name security.put_user * @availability stack stability=stable */ diff --git a/specification/security/query_api_keys/QueryApiKeysRequest.ts b/specification/security/query_api_keys/QueryApiKeysRequest.ts index 74ffb932be..363182881a 100644 --- a/specification/security/query_api_keys/QueryApiKeysRequest.ts +++ b/specification/security/query_api_keys/QueryApiKeysRequest.ts @@ -24,8 +24,9 @@ import { Sort, SortResults } from '@_types/sort' import { ApiKeyAggregationContainer, ApiKeyQueryContainer } from './types' /** - * Query API keys. - * Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query. + * 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. * @rest_spec_name security.query_api_keys * @availability stack since=7.15.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/security/query_role/QueryRolesRequest.ts b/specification/security/query_role/QueryRolesRequest.ts index 63fce15d68..9d0a93dde6 100644 --- a/specification/security/query_role/QueryRolesRequest.ts +++ b/specification/security/query_role/QueryRolesRequest.ts @@ -23,7 +23,9 @@ import { Sort, SortResults } from '@_types/sort' import { RoleQueryContainer } from './types' /** - * Retrieves roles in a paginated manner. You can optionally filter the results with a query. + * Find roles with a query. + * + * Get roles in a paginated manner. You can optionally filter the results with a query. * @rest_spec_name security.query_role * @availability stack since=8.15.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/query_user/SecurityQueryUserRequest.ts b/specification/security/query_user/SecurityQueryUserRequest.ts index e48823cdf3..e567ed96a4 100644 --- a/specification/security/query_user/SecurityQueryUserRequest.ts +++ b/specification/security/query_user/SecurityQueryUserRequest.ts @@ -23,7 +23,10 @@ import { Sort, SortResults } from '@_types/sort' import { UserQueryContainer } from './types' /** - * Retrieves information for Users in a paginated manner. You can optionally filter the results with a query. + * Find users with a query. + * + * Get information for users in a paginated manner. + * You can optionally filter the results with a query. * @rest_spec_name security.query_user * @availability stack since=8.14.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/saml_authenticate/Request.ts b/specification/security/saml_authenticate/Request.ts index 301cc098f5..f3361e17e1 100644 --- a/specification/security/saml_authenticate/Request.ts +++ b/specification/security/saml_authenticate/Request.ts @@ -21,7 +21,9 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** - * Submits a SAML Response message to Elasticsearch for consumption. + * Authenticate SAML. + * + * Submits a SAML response message to Elasticsearch for consumption. * @rest_spec_name security.saml_authenticate * @availability stack since=7.5.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/saml_complete_logout/Request.ts b/specification/security/saml_complete_logout/Request.ts index a5cbedec3a..f85e46086a 100644 --- a/specification/security/saml_complete_logout/Request.ts +++ b/specification/security/saml_complete_logout/Request.ts @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** + * Logout of SAML completely. + * * Verifies the logout response sent from the SAML IdP. * @rest_spec_name security.saml_complete_logout * @availability stack since=7.14.0 stability=stable diff --git a/specification/security/saml_invalidate/Request.ts b/specification/security/saml_invalidate/Request.ts index f0fab7cd44..687efc679c 100644 --- a/specification/security/saml_invalidate/Request.ts +++ b/specification/security/saml_invalidate/Request.ts @@ -20,6 +20,8 @@ import { RequestBase } from '@_types/Base' /** + * Invalidate SAML. + * * Submits a SAML LogoutRequest message to Elasticsearch for consumption. * @rest_spec_name security.saml_invalidate * @availability stack since=7.5.0 stability=stable diff --git a/specification/security/saml_logout/Request.ts b/specification/security/saml_logout/Request.ts index dbd8473658..672f43f422 100644 --- a/specification/security/saml_logout/Request.ts +++ b/specification/security/saml_logout/Request.ts @@ -20,6 +20,8 @@ import { RequestBase } from '@_types/Base' /** + * Logout of SAML. + * * Submits a request to invalidate an access token and refresh token. * @rest_spec_name security.saml_logout * @availability stack since=7.5.0 stability=stable diff --git a/specification/security/saml_prepare_authentication/Request.ts b/specification/security/saml_prepare_authentication/Request.ts index 604090cd1a..994cf0b915 100644 --- a/specification/security/saml_prepare_authentication/Request.ts +++ b/specification/security/saml_prepare_authentication/Request.ts @@ -20,7 +20,9 @@ import { RequestBase } from '@_types/Base' /** - * Creates a SAML authentication request () as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. + * Prepare SAML authentication. + * + * Creates a SAML authentication request (``) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch. * @rest_spec_name security.saml_prepare_authentication * @availability stack since=7.5.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/saml_service_provider_metadata/Request.ts b/specification/security/saml_service_provider_metadata/Request.ts index 50deb7df67..3f285b066e 100644 --- a/specification/security/saml_service_provider_metadata/Request.ts +++ b/specification/security/saml_service_provider_metadata/Request.ts @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Create SAML service provider metadata. + * * Generate SAML metadata for a SAML 2.0 Service Provider. * @rest_spec_name security.saml_service_provider_metadata * @availability stack since=7.11.0 stability=stable diff --git a/specification/security/suggest_user_profiles/Request.ts b/specification/security/suggest_user_profiles/Request.ts index daa720a5b2..29cf4d6daf 100644 --- a/specification/security/suggest_user_profiles/Request.ts +++ b/specification/security/suggest_user_profiles/Request.ts @@ -22,6 +22,8 @@ import { long } from '@_types/Numeric' import { Hint } from './types' /** + * Suggest a user profile. + * * Get suggestions for user profiles that match specified search criteria. * @rest_spec_name security.suggest_user_profiles * @availability stack since=8.2.0 stability=stable diff --git a/specification/security/update_api_key/Request.ts b/specification/security/update_api_key/Request.ts index 117424c44f..790d25c1ea 100644 --- a/specification/security/update_api_key/Request.ts +++ b/specification/security/update_api_key/Request.ts @@ -25,6 +25,7 @@ import { Duration } from '@_types/Time' /** * 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. diff --git a/specification/security/update_user_profile_data/Request.ts b/specification/security/update_user_profile_data/Request.ts index ef6d3d83bb..cd03ee460b 100644 --- a/specification/security/update_user_profile_data/Request.ts +++ b/specification/security/update_user_profile_data/Request.ts @@ -25,7 +25,9 @@ import { Refresh, SequenceNumber } from '@_types/common' import { long } from '@_types/Numeric' /** - * Updates specific data for the user profile that's associated with the specified unique ID. + * Update user profile data. + * + * Update specific data for the user profile that is associated with a unique ID. * @rest_spec_name security.update_user_profile_data * @availability stack since=8.2.0 stability=stable * @availability serverless stability=stable visibility=private