diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index c778c3b5a5..7d9601d4dd 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -26913,7 +26913,8 @@ "tags": [ "security" ], - "summary": "Creates or updates a user profile on behalf of another user", + "summary": "Activate a user profile", + "description": "Create or update a user profile on behalf of another user.", "operationId": "security-activate-user-profile", "requestBody": { "content": { @@ -27048,8 +27049,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The get roles API cannot retrieve roles that are defined in roles files.", + "summary": "Get roles", + "description": "Get roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", "operationId": "security-get-role-1", "responses": { "200": { @@ -27061,8 +27062,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The bulk create or update roles API cannot update roles that are defined in roles files.", + "summary": "Bulk create or update roles", + "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", "operationId": "security-bulk-put-role", "parameters": [ { @@ -27142,8 +27143,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The bulk delete roles API cannot delete roles that are defined in roles files.", + "summary": "Bulk delete roles", + "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", "operationId": "security-bulk-delete-role", "parameters": [ { @@ -27218,7 +27219,8 @@ "tags": [ "security" ], - "summary": "Changes the passwords of users in the native realm and built-in users", + "summary": "Change passwords", + "description": "Change the passwords of users in the native realm and built-in users.", "operationId": "security-change-password", "parameters": [ { @@ -27241,7 +27243,8 @@ "tags": [ "security" ], - "summary": "Changes the passwords of users in the native realm and built-in users", + "summary": "Change passwords", + "description": "Change the passwords of users in the native realm and built-in users.", "operationId": "security-change-password-1", "parameters": [ { @@ -27266,7 +27269,8 @@ "tags": [ "security" ], - "summary": "Changes the passwords of users in the native realm and built-in users", + "summary": "Change passwords", + "description": "Change the passwords of users in the native realm and built-in users.", "operationId": "security-change-password-2", "parameters": [ { @@ -27286,7 +27290,8 @@ "tags": [ "security" ], - "summary": "Changes the passwords of users in the native realm and built-in users", + "summary": "Change passwords", + "description": "Change the passwords of users in the native realm and built-in users.", "operationId": "security-change-password-3", "parameters": [ { @@ -27308,8 +27313,8 @@ "tags": [ "security" ], - "summary": "Evicts a subset of all entries from the API key cache", - "description": "The cache is also automatically cleared on state changes of the security index.", + "summary": "Clear the API key cache", + "description": "Evict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", "operationId": "security-clear-api-key-cache", "parameters": [ { @@ -27363,7 +27368,8 @@ "tags": [ "security" ], - "summary": "Evicts application privileges from the native application privileges cache", + "summary": "Clear the privileges cache", + "description": "Evict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", "operationId": "security-clear-cached-privileges", "parameters": [ { @@ -27417,8 +27423,8 @@ "tags": [ "security" ], - "summary": "Evicts users from the user cache", - "description": "Can completely clear the cache or evict specific users.", + "summary": "Clear the user cache", + "description": "Evict users from the user cache. You can completely clear the cache or evict specific users.", "operationId": "security-clear-cached-realms", "parameters": [ { @@ -27484,7 +27490,8 @@ "tags": [ "security" ], - "summary": "Evicts roles from the native role cache", + "summary": "Clear the roles cache", + "description": "Evict roles from the native role cache.", "operationId": "security-clear-cached-roles", "parameters": [ { @@ -27537,7 +27544,11 @@ "tags": [ "security" ], - "summary": "Evicts tokens from the service account token caches", + "summary": "Clear service account token caches", + "description": "Evict a subset of all entries from the service account token caches.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-clear-cached-service-tokens", "parameters": [ { @@ -27727,7 +27738,7 @@ "security" ], "summary": "Create an API key", - "description": "Creates an API key for access without requiring basic authentication.\nA successful request 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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key for access without requiring basic authentication.\nA successful request 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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "operationId": "security-create-api-key", "parameters": [ { @@ -27749,7 +27760,7 @@ "security" ], "summary": "Create an API key", - "description": "Creates an API key for access without requiring basic authentication.\nA successful request 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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key for access without requiring basic authentication.\nA successful request 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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "operationId": "security-create-api-key-1", "parameters": [ { @@ -27857,7 +27868,11 @@ "tags": [ "security" ], - "summary": "Creates a service accounts token for access without requiring basic authentication", + "summary": "Create a service account token", + "description": "Create a service accounts token for access without requiring basic authentication.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-create-service-token", "parameters": [ { @@ -27883,7 +27898,11 @@ "tags": [ "security" ], - "summary": "Creates a service accounts token for access without requiring basic authentication", + "summary": "Create a service account token", + "description": "Create a service accounts token for access without requiring basic authentication.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-create-service-token-1", "parameters": [ { @@ -27909,7 +27928,11 @@ "tags": [ "security" ], - "summary": "Deletes a service account token", + "summary": "Delete service account tokens", + "description": "Delete service account tokens for a service in a specified namespace.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-delete-service-token", "parameters": [ { @@ -27984,7 +28007,11 @@ "tags": [ "security" ], - "summary": "Creates a service accounts token for access without requiring basic authentication", + "summary": "Create a service account token", + "description": "Create a service accounts token for access without requiring basic authentication.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-create-service-token-2", "parameters": [ { @@ -28009,7 +28036,10 @@ "tags": [ "security" ], - "summary": "Retrieves application privileges", + "summary": "Get application privileges", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-get-privileges-2", "parameters": [ { @@ -28030,7 +28060,10 @@ "tags": [ "security" ], - "summary": "Removes application privileges", + "summary": "Delete application privileges", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-delete-privileges", "parameters": [ { @@ -28092,8 +28125,8 @@ "tags": [ "security" ], - "summary": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management", - "description": "The get roles API cannot retrieve roles that are defined in roles files.", + "summary": "Get roles", + "description": "Get roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", "operationId": "security-get-role", "parameters": [ { @@ -28158,7 +28191,8 @@ "tags": [ "security" ], - "summary": "Removes roles in the native realm", + "summary": "Delete roles", + "description": "Delete roles in the native realm.", "operationId": "security-delete-role", "parameters": [ { @@ -28210,7 +28244,11 @@ "tags": [ "security" ], - "summary": "Retrieves role mappings", + "summary": "Get role mappings", + "description": "Role mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html" + }, "operationId": "security-get-role-mapping", "parameters": [ { @@ -28276,7 +28314,7 @@ "tags": [ "security" ], - "summary": "Removes role mappings", + "summary": "Delete role mappings", "operationId": "security-delete-role-mapping", "parameters": [ { @@ -28329,7 +28367,8 @@ "tags": [ "security" ], - "summary": "Retrieves information about users in the native realm and built-in users", + "summary": "Get users", + "description": "Get information about users in the native realm and built-in users.", "operationId": "security-get-user", "parameters": [ { @@ -28397,7 +28436,8 @@ "tags": [ "security" ], - "summary": "Deletes users from the native realm", + "summary": "Delete users", + "description": "Delete users from the native realm.", "operationId": "security-delete-user", "parameters": [ { @@ -28449,7 +28489,8 @@ "tags": [ "security" ], - "summary": "Disables users in the native realm", + "summary": "Disable users", + "description": "Disable users in the native realm.", "operationId": "security-disable-user", "parameters": [ { @@ -28469,7 +28510,8 @@ "tags": [ "security" ], - "summary": "Disables users in the native realm", + "summary": "Disable users", + "description": "Disable users in the native realm.", "operationId": "security-disable-user-1", "parameters": [ { @@ -28491,7 +28533,8 @@ "tags": [ "security" ], - "summary": "Disables a user profile so it's not visible in user profile searches", + "summary": "Disable a user profile", + "description": "Disable user profiles so that they are not visible in user profile searches.", "operationId": "security-disable-user-profile", "parameters": [ { @@ -28512,7 +28555,8 @@ "tags": [ "security" ], - "summary": "Disables a user profile so it's not visible in user profile searches", + "summary": "Disable a user profile", + "description": "Disable user profiles so that they are not visible in user profile searches.", "operationId": "security-disable-user-profile-1", "parameters": [ { @@ -28535,7 +28579,8 @@ "tags": [ "security" ], - "summary": "Enables users in the native realm", + "summary": "Enable users", + "description": "Enable users in the native realm.", "operationId": "security-enable-user", "parameters": [ { @@ -28555,7 +28600,8 @@ "tags": [ "security" ], - "summary": "Enables users in the native realm", + "summary": "Enable users", + "description": "Enable users in the native realm.", "operationId": "security-enable-user-1", "parameters": [ { @@ -28577,7 +28623,8 @@ "tags": [ "security" ], - "summary": "Enables a user profile so it's visible in user profile searches", + "summary": "Enable a user profile", + "description": "Enable user profiles to make them visible in user profile searches.", "operationId": "security-enable-user-profile", "parameters": [ { @@ -28598,7 +28645,8 @@ "tags": [ "security" ], - "summary": "Enables a user profile so it's visible in user profile searches", + "summary": "Enable a user profile", + "description": "Enable user profiles to make them visible in user profile searches.", "operationId": "security-enable-user-profile-1", "parameters": [ { @@ -28621,7 +28669,8 @@ "tags": [ "security" ], - "summary": "Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster", + "summary": "Enroll Kibana", + "description": "Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", "operationId": "security-enroll-kibana", "responses": { "200": { @@ -28655,7 +28704,8 @@ "tags": [ "security" ], - "summary": "Allows a new node to join an existing cluster with security features enabled", + "summary": "Enroll a node", + "description": "Enroll a new node to allow it to join an existing cluster with security features enabled.", "operationId": "security-enroll-node", "responses": { "200": { @@ -28708,7 +28758,11 @@ "tags": [ "security" ], - "summary": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch", + "summary": "Get builtin privileges", + "description": "Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-get-builtin-privileges", "responses": { "200": { @@ -28745,7 +28799,10 @@ "tags": [ "security" ], - "summary": "Retrieves application privileges", + "summary": "Get application privileges", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-get-privileges", "responses": { "200": { @@ -28802,7 +28859,10 @@ "tags": [ "security" ], - "summary": "Retrieves application privileges", + "summary": "Get application privileges", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html" + }, "operationId": "security-get-privileges-1", "parameters": [ { @@ -28822,7 +28882,11 @@ "tags": [ "security" ], - "summary": "Retrieves role mappings", + "summary": "Get role mappings", + "description": "Role mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-roles.html" + }, "operationId": "security-get-role-mapping-1", "responses": { "200": { @@ -28837,7 +28901,11 @@ "tags": [ "security" ], - "summary": "This API returns a list of service accounts that match the provided path parameter(s)", + "summary": "Get service accounts", + "description": "Get a list of service accounts that match the provided path parameters.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-get-service-accounts", "parameters": [ { @@ -28860,7 +28928,11 @@ "tags": [ "security" ], - "summary": "This API returns a list of service accounts that match the provided path parameter(s)", + "summary": "Get service accounts", + "description": "Get a list of service accounts that match the provided path parameters.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-get-service-accounts-1", "parameters": [ { @@ -28880,7 +28952,11 @@ "tags": [ "security" ], - "summary": "This API returns a list of service accounts that match the provided path parameter(s)", + "summary": "Get service accounts", + "description": "Get a list of service accounts that match the provided path parameters.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-get-service-accounts-2", "responses": { "200": { @@ -28895,7 +28971,10 @@ "tags": [ "security" ], - "summary": "Retrieves information of all service credentials for a service account", + "summary": "Get service account credentials", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/service-accounts.html" + }, "operationId": "security-get-service-credentials", "parameters": [ { @@ -28964,7 +29043,8 @@ "tags": [ "security" ], - "summary": "Creates a bearer token for access without requiring basic authentication", + "summary": "Get a token", + "description": "Create a bearer token for access without requiring basic authentication.", "operationId": "security-get-token", "requestBody": { "content": { @@ -29111,7 +29191,8 @@ "tags": [ "security" ], - "summary": "Retrieves information about users in the native realm and built-in users", + "summary": "Get users", + "description": "Get information about users in the native realm and built-in users.", "operationId": "security-get-user-1", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 479774054a..35bee09f10 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -17076,7 +17076,7 @@ "security" ], "summary": "Create an API key", - "description": "Creates an API key for access without requiring basic authentication.\nA successful request 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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key for access without requiring basic authentication.\nA successful request 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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "operationId": "security-create-api-key", "parameters": [ { @@ -17098,7 +17098,7 @@ "security" ], "summary": "Create an API key", - "description": "Creates an API key for access without requiring basic authentication.\nA successful request 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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key for access without requiring basic authentication.\nA successful request 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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "operationId": "security-create-api-key-1", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 2e5d8d6af5..eaa6b1a7c6 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -15016,7 +15016,7 @@ "stability": "stable" } }, - "description": "Creates or updates a user profile on behalf of another user.", + "description": "Activate a user profile.\n\nCreate or update a user profile on behalf of another user.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-activate-user-profile.html", "name": "security.activate_user_profile", "privileges": { @@ -15059,7 +15059,7 @@ "stability": "stable" } }, - "description": "Authenticate a user.\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA 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.\nIf the user cannot be authenticated, this API returns a 401 status code.", + "description": "Authenticate a user.\n\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA 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.\nIf the user cannot be authenticated, this API returns a 401 status code.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html", "name": "security.authenticate", "request": { @@ -15094,7 +15094,7 @@ "stability": "stable" } }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", + "description": "Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-delete-role.html", "name": "security.bulk_delete_role", "privileges": { @@ -15137,7 +15137,7 @@ "stability": "stable" } }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", + "description": "Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-put-role.html", "name": "security.bulk_put_role", "privileges": { @@ -15203,7 +15203,7 @@ "stability": "stable" } }, - "description": "Changes the passwords of users in the native realm and built-in users.", + "description": "Change passwords.\n\nChange the passwords of users in the native realm and built-in users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html", "name": "security.change_password", "request": { @@ -15249,7 +15249,7 @@ "stability": "stable" } }, - "description": "Evicts a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", + "description": "Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html", "name": "security.clear_api_key_cache", "privileges": { @@ -15289,7 +15289,7 @@ "stability": "stable" } }, - "description": "Evicts application privileges from the native application privileges cache.", + "description": "Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html", "name": "security.clear_cached_privileges", "request": { @@ -15323,7 +15323,7 @@ "stability": "stable" } }, - "description": "Evicts users from the user cache. Can completely clear the cache or evict specific users.", + "description": "Clear the user cache.\n\nEvict users from the user cache. You can completely clear the cache or evict specific users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html", "name": "security.clear_cached_realms", "request": { @@ -15357,7 +15357,7 @@ "stability": "stable" } }, - "description": "Evicts roles from the native role cache.", + "description": "Clear the roles cache.\n\nEvict roles from the native role cache.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html", "name": "security.clear_cached_roles", "request": { @@ -15391,8 +15391,10 @@ "stability": "stable" } }, - "description": "Evicts tokens from the service account token caches.", + "description": "Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html", + "extDocId": "service-accounts", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.clear_cached_service_tokens", "request": { "name": "Request", @@ -15426,7 +15428,7 @@ "stability": "stable" } }, - "description": "Create an API key.\nCreates an API key for access without requiring basic authentication.\nA successful request 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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\nA successful request 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.\nNOTE: By 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-create-api-key.html", "name": "security.create_api_key", "privileges": { @@ -15497,8 +15499,10 @@ "stability": "stable" } }, - "description": "Creates a service accounts token for access without requiring basic authentication.", + "description": "Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html", + "extDocId": "service-accounts", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.create_service_token", "request": { "name": "Request", @@ -15539,8 +15543,10 @@ "stability": "stable" } }, - "description": "Removes application privileges.", + "description": "Delete application privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html", + "extDocId": "security-privileges", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.delete_privileges", "request": { "name": "Request", @@ -15573,7 +15579,7 @@ "stability": "stable" } }, - "description": "Removes roles in the native realm.", + "description": "Delete roles.\n\nDelete roles in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html", "name": "security.delete_role", "request": { @@ -15608,7 +15614,7 @@ "stability": "stable" } }, - "description": "Removes role mappings.", + "description": "Delete role mappings.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html", "name": "security.delete_role_mapping", "request": { @@ -15643,8 +15649,10 @@ "stability": "stable" } }, - "description": "Deletes a service account token.", + "description": "Delete service account tokens.\n\nDelete service account tokens for a service in a specified namespace.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html", + "extDocId": "service-accounts", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.delete_service_token", "request": { "name": "Request", @@ -15673,7 +15681,7 @@ "stability": "stable" } }, - "description": "Deletes users from the native realm.", + "description": "Delete users.\n\nDelete users from the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html", "name": "security.delete_user", "request": { @@ -15703,7 +15711,7 @@ "stability": "stable" } }, - "description": "Disables users in the native realm.", + "description": "Disable users.\n\nDisable users in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html", "name": "security.disable_user", "request": { @@ -15739,7 +15747,7 @@ "stability": "stable" } }, - "description": "Disables a user profile so it's not visible in user profile searches.", + "description": "Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html", "name": "security.disable_user_profile", "privileges": { @@ -15775,7 +15783,7 @@ "stability": "stable" } }, - "description": "Enables users in the native realm.", + "description": "Enable users.\n\nEnable users in the native realm.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html", "name": "security.enable_user", "request": { @@ -15811,7 +15819,7 @@ "stability": "stable" } }, - "description": "Enables a user profile so it's visible in user profile searches.", + "description": "Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html", "name": "security.enable_user_profile", "privileges": { @@ -15848,7 +15856,7 @@ "stability": "stable" } }, - "description": "Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", + "description": "Enroll Kibana.\n\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html", "name": "security.enroll_kibana", "request": { @@ -15882,7 +15890,7 @@ "stability": "stable" } }, - "description": "Allows a new node to join an existing cluster with security features enabled.", + "description": "Enroll a node.\n\nEnroll a new node to allow it to join an existing cluster with security features enabled.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html", "name": "security.enroll_node", "request": { @@ -15920,7 +15928,7 @@ "stability": "stable" } }, - "description": "Get API key information.\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", + "description": "Get API key information.\n\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html", "name": "security.get_api_key", "privileges": { @@ -15961,8 +15969,10 @@ "stability": "stable" } }, - "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges.\n\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html", + "extDocId": "security-privileges", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.get_builtin_privileges", "privileges": { "cluster": [ @@ -16001,8 +16011,10 @@ "stability": "stable" } }, - "description": "Retrieves application privileges.", + "description": "Get application privileges.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html", + "extDocId": "security-privileges", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html", "name": "security.get_privileges", "request": { "name": "Request", @@ -16047,7 +16059,7 @@ "stability": "stable" } }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", + "description": "Get roles.\n\nGet roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html", "name": "security.get_role", "privileges": { @@ -16093,8 +16105,10 @@ "stability": "stable" } }, - "description": "Retrieves role mappings.", + "description": "Get role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html", + "extDocId": "mapping-roles", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html", "name": "security.get_role_mapping", "privileges": { "cluster": [ @@ -16139,8 +16153,10 @@ "stability": "stable" } }, - "description": "This API returns a list of service accounts that match the provided path parameter(s).", + "description": "Get service accounts.\n\nGet a list of service accounts that match the provided path parameters.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html", + "extDocId": "service-accounts", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.get_service_accounts", "privileges": { "cluster": [ @@ -16191,8 +16207,10 @@ "stability": "stable" } }, - "description": "Retrieves information of all service credentials for a service account.", + "description": "Get service account credentials.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html", + "extDocId": "service-accounts", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html", "name": "security.get_service_credentials", "request": { "name": "Request", @@ -16254,7 +16272,7 @@ "stability": "stable" } }, - "description": "Creates a bearer token for access without requiring basic authentication.", + "description": "Get a token.\n\nCreate a bearer token for access without requiring basic authentication.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html", "name": "security.get_token", "request": { @@ -16287,7 +16305,7 @@ "stability": "stable" } }, - "description": "Retrieves information about users in the native realm and built-in users.", + "description": "Get users.\n\nGet information about users in the native realm and built-in users.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html", "name": "security.get_user", "request": { @@ -188239,7 +188257,7 @@ } ] }, - "description": "Creates or updates a user profile on behalf of another user.", + "description": "Activate a user profile.\n\nCreate or update a user profile on behalf of another user.", "inherits": { "type": { "name": "RequestBase", @@ -188252,7 +188270,7 @@ }, "path": [], "query": [], - "specLocation": "security/activate_user_profile/Request.ts#L23-L37" + "specLocation": "security/activate_user_profile/Request.ts#L23-L39" }, { "kind": "response", @@ -188280,7 +188298,7 @@ "body": { "kind": "no_body" }, - "description": "Authenticate a user.\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA 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.\nIf the user cannot be authenticated, this API returns a 401 status code.", + "description": "Authenticate a user.\n\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA 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.\nIf the user cannot be authenticated, this API returns a 401 status code.", "inherits": { "type": { "name": "RequestBase", @@ -188293,7 +188311,7 @@ }, "path": [], "query": [], - "specLocation": "security/authenticate/SecurityAuthenticateRequest.ts#L22-L32" + "specLocation": "security/authenticate/SecurityAuthenticateRequest.ts#L22-L33" }, { "kind": "response", @@ -188525,7 +188543,7 @@ } ] }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", + "description": "Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.", "inherits": { "type": { "name": "RequestBase", @@ -188551,7 +188569,7 @@ } } ], - "specLocation": "security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L41" + "specLocation": "security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts#L23-L43" }, { "kind": "response", @@ -188641,7 +188659,7 @@ } ] }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", + "description": "Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.", "inherits": { "type": { "name": "RequestBase", @@ -188667,7 +188685,7 @@ } } ], - "specLocation": "security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L43" + "specLocation": "security/bulk_put_role/SecurityBulkPutRoleRequest.ts#L25-L45" }, { "kind": "response", @@ -188773,7 +188791,7 @@ } ] }, - "description": "Changes the passwords of users in the native realm and built-in users.", + "description": "Change passwords.\n\nChange the passwords of users in the native realm and built-in users.", "inherits": { "type": { "name": "RequestBase", @@ -188812,7 +188830,7 @@ } } ], - "specLocation": "security/change_password/SecurityChangePasswordRequest.ts#L23-L51" + "specLocation": "security/change_password/SecurityChangePasswordRequest.ts#L23-L54" }, { "kind": "response", @@ -188834,7 +188852,7 @@ "body": { "kind": "no_body" }, - "description": "Evicts a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", + "description": "Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", "inherits": { "type": { "name": "RequestBase", @@ -188860,7 +188878,7 @@ } ], "query": [], - "specLocation": "security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts#L23-L40" + "specLocation": "security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts#L23-L42" }, { "kind": "response", @@ -188928,7 +188946,7 @@ "body": { "kind": "no_body" }, - "description": "Evicts application privileges from the native application privileges cache.", + "description": "Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", "inherits": { "type": { "name": "RequestBase", @@ -188954,7 +188972,7 @@ } ], "query": [], - "specLocation": "security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts#L23-L32" + "specLocation": "security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts#L23-L36" }, { "kind": "response", @@ -189022,7 +189040,7 @@ "body": { "kind": "no_body" }, - "description": "Evicts users from the user cache. Can completely clear the cache or evict specific users.", + "description": "Clear the user cache.\n\nEvict users from the user cache. You can completely clear the cache or evict specific users.", "inherits": { "type": { "name": "RequestBase", @@ -189064,7 +189082,7 @@ } } ], - "specLocation": "security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts#L23-L35" + "specLocation": "security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts#L23-L38" }, { "kind": "response", @@ -189132,7 +189150,7 @@ "body": { "kind": "no_body" }, - "description": "Evicts roles from the native role cache.", + "description": "Clear the roles cache.\n\nEvict roles from the native role cache.", "inherits": { "type": { "name": "RequestBase", @@ -189158,7 +189176,7 @@ } ], "query": [], - "specLocation": "security/clear_cached_roles/ClearCachedRolesRequest.ts#L23-L32" + "specLocation": "security/clear_cached_roles/ClearCachedRolesRequest.ts#L23-L35" }, { "kind": "response", @@ -189226,7 +189244,7 @@ "body": { "kind": "no_body" }, - "description": "Evicts tokens from the service account token caches.", + "description": "Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.", "inherits": { "type": { "name": "RequestBase", @@ -189276,7 +189294,7 @@ } ], "query": [], - "specLocation": "security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts#L23-L34" + "specLocation": "security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts#L23-L38" }, { "kind": "response", @@ -189413,7 +189431,7 @@ } ] }, - "description": "Create an API key.\nCreates an API key for access without requiring basic authentication.\nA successful request 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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", + "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\nA successful request 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.\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.", "inherits": { "type": { "name": "RequestBase", @@ -189439,7 +189457,7 @@ } } ], - "specLocation": "security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L59" + "specLocation": "security/create_api_key/SecurityCreateApiKeyRequest.ts#L26-L60" }, { "kind": "response", @@ -189528,7 +189546,7 @@ "body": { "kind": "no_body" }, - "description": "Creates a service accounts token for access without requiring basic authentication.", + "description": "Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.", "inherits": { "type": { "name": "RequestBase", @@ -189591,7 +189609,7 @@ } } ], - "specLocation": "security/create_service_token/CreateServiceTokenRequest.ts#L23-L38" + "specLocation": "security/create_service_token/CreateServiceTokenRequest.ts#L23-L41" }, { "kind": "response", @@ -189689,7 +189707,7 @@ "body": { "kind": "no_body" }, - "description": "Removes application privileges.", + "description": "Delete application privileges.", "inherits": { "type": { "name": "RequestBase", @@ -189740,7 +189758,7 @@ } } ], - "specLocation": "security/delete_privileges/SecurityDeletePrivilegesRequest.ts#L23-L36" + "specLocation": "security/delete_privileges/SecurityDeletePrivilegesRequest.ts#L23-L38" }, { "kind": "response", @@ -189790,7 +189808,7 @@ "body": { "kind": "no_body" }, - "description": "Removes roles in the native realm.", + "description": "Delete roles.\n\nDelete roles in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -189829,7 +189847,7 @@ } } ], - "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L35" + "specLocation": "security/delete_role/SecurityDeleteRoleRequest.ts#L23-L38" }, { "kind": "response", @@ -189863,7 +189881,7 @@ "body": { "kind": "no_body" }, - "description": "Removes role mappings.", + "description": "Delete role mappings.", "inherits": { "type": { "name": "RequestBase", @@ -189902,7 +189920,7 @@ } } ], - "specLocation": "security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts#L23-L35" + "specLocation": "security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts#L23-L36" }, { "kind": "response", @@ -189936,7 +189954,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a service account token.", + "description": "Delete service account tokens.\n\nDelete service account tokens for a service in a specified namespace.", "inherits": { "type": { "name": "RequestBase", @@ -189999,7 +190017,7 @@ } } ], - "specLocation": "security/delete_service_token/DeleteServiceTokenRequest.ts#L23-L37" + "specLocation": "security/delete_service_token/DeleteServiceTokenRequest.ts#L23-L41" }, { "kind": "response", @@ -190033,7 +190051,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes users from the native realm.", + "description": "Delete users.\n\nDelete users from the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190072,7 +190090,7 @@ } } ], - "specLocation": "security/delete_user/SecurityDeleteUserRequest.ts#L23-L34" + "specLocation": "security/delete_user/SecurityDeleteUserRequest.ts#L23-L37" }, { "kind": "response", @@ -190106,7 +190124,7 @@ "body": { "kind": "no_body" }, - "description": "Disables users in the native realm.", + "description": "Disable users.\n\nDisable users in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190145,7 +190163,7 @@ } } ], - "specLocation": "security/disable_user/SecurityDisableUserRequest.ts#L23-L34" + "specLocation": "security/disable_user/SecurityDisableUserRequest.ts#L23-L37" }, { "kind": "response", @@ -190167,7 +190185,7 @@ "body": { "kind": "no_body" }, - "description": "Disables a user profile so it's not visible in user profile searches.", + "description": "Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.", "inherits": { "type": { "name": "RequestBase", @@ -190207,7 +190225,7 @@ } } ], - "specLocation": "security/disable_user_profile/Request.ts#L24-L47" + "specLocation": "security/disable_user_profile/Request.ts#L24-L49" }, { "kind": "response", @@ -190235,7 +190253,7 @@ "body": { "kind": "no_body" }, - "description": "Enables users in the native realm.", + "description": "Enable users.\n\nEnable users in the native realm.", "inherits": { "type": { "name": "RequestBase", @@ -190274,7 +190292,7 @@ } } ], - "specLocation": "security/enable_user/SecurityEnableUserRequest.ts#L23-L34" + "specLocation": "security/enable_user/SecurityEnableUserRequest.ts#L23-L37" }, { "kind": "response", @@ -190296,7 +190314,7 @@ "body": { "kind": "no_body" }, - "description": "Enables a user profile so it's visible in user profile searches.", + "description": "Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.", "inherits": { "type": { "name": "RequestBase", @@ -190336,7 +190354,7 @@ } } ], - "specLocation": "security/enable_user_profile/Request.ts#L24-L47" + "specLocation": "security/enable_user_profile/Request.ts#L24-L49" }, { "kind": "response", @@ -190364,7 +190382,7 @@ "body": { "kind": "no_body" }, - "description": "Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", + "description": "Enroll Kibana.\n\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.", "inherits": { "type": { "name": "RequestBase", @@ -190377,7 +190395,7 @@ }, "path": [], "query": [], - "specLocation": "security/enroll_kibana/Request.ts#L22-L27" + "specLocation": "security/enroll_kibana/Request.ts#L22-L29" }, { "kind": "response", @@ -190454,7 +190472,7 @@ "body": { "kind": "no_body" }, - "description": "Allows a new node to join an existing cluster with security features enabled.", + "description": "Enroll a node.\n\nEnroll a new node to allow it to join an existing cluster with security features enabled.", "inherits": { "type": { "name": "RequestBase", @@ -190467,7 +190485,7 @@ }, "path": [], "query": [], - "specLocation": "security/enroll_node/Request.ts#L22-L27" + "specLocation": "security/enroll_node/Request.ts#L22-L29" }, { "kind": "response", @@ -190559,7 +190577,7 @@ "body": { "kind": "no_body" }, - "description": "Get API key information.\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", + "description": "Get API key information.\n\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", "inherits": { "type": { "name": "RequestBase", @@ -190691,7 +190709,7 @@ } } ], - "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L87" + "specLocation": "security/get_api_key/SecurityGetApiKeyRequest.ts#L23-L88" }, { "kind": "response", @@ -190728,7 +190746,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", + "description": "Get builtin privileges.\n\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "inherits": { "type": { "name": "RequestBase", @@ -190741,7 +190759,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L28" + "specLocation": "security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts#L22-L32" }, { "kind": "response", @@ -190789,7 +190807,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves application privileges.", + "description": "Get application privileges.", "inherits": { "type": { "name": "RequestBase", @@ -190827,7 +190845,7 @@ } ], "query": [], - "specLocation": "security/get_privileges/SecurityGetPrivilegesRequest.ts#L23-L33" + "specLocation": "security/get_privileges/SecurityGetPrivilegesRequest.ts#L23-L35" }, { "kind": "response", @@ -190877,7 +190895,7 @@ "body": { "kind": "no_body" }, - "description": "The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", + "description": "Get roles.\n\nGet roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", "inherits": { "type": { "name": "RequestBase", @@ -190903,7 +190921,7 @@ } ], "query": [], - "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L38" + "specLocation": "security/get_role/SecurityGetRoleRequest.ts#L23-L41" }, { "kind": "response", @@ -191104,7 +191122,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves role mappings.", + "description": "Get role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", "inherits": { "type": { "name": "RequestBase", @@ -191130,7 +191148,7 @@ } ], "query": [], - "specLocation": "security/get_role_mapping/SecurityGetRoleMappingRequest.ts#L23-L36" + "specLocation": "security/get_role_mapping/SecurityGetRoleMappingRequest.ts#L23-L42" }, { "kind": "response", @@ -191169,7 +191187,7 @@ "body": { "kind": "no_body" }, - "description": "This API returns a list of service accounts that match the provided path parameter(s).", + "description": "Get service accounts.\n\nGet a list of service accounts that match the provided path parameters.", "inherits": { "type": { "name": "RequestBase", @@ -191207,7 +191225,7 @@ } ], "query": [], - "specLocation": "security/get_service_accounts/GetServiceAccountsRequest.ts#L23-L41" + "specLocation": "security/get_service_accounts/GetServiceAccountsRequest.ts#L23-L44" }, { "kind": "response", @@ -191336,7 +191354,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information of all service credentials for a service account.", + "description": "Get service account credentials.", "inherits": { "type": { "name": "RequestBase", @@ -191374,7 +191392,7 @@ } ], "query": [], - "specLocation": "security/get_service_credentials/GetServiceCredentialsRequest.ts#L23-L39" + "specLocation": "security/get_service_credentials/GetServiceCredentialsRequest.ts#L23-L41" }, { "kind": "response", @@ -191635,7 +191653,7 @@ } ] }, - "description": "Creates a bearer token for access without requiring basic authentication.", + "description": "Get a token.\n\nCreate a bearer token for access without requiring basic authentication.", "inherits": { "type": { "name": "RequestBase", @@ -191648,7 +191666,7 @@ }, "path": [], "query": [], - "specLocation": "security/get_token/GetUserAccessTokenRequest.ts#L25-L39" + "specLocation": "security/get_token/GetUserAccessTokenRequest.ts#L25-L42" }, { "kind": "response", @@ -191780,7 +191798,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information about users in the native realm and built-in users.", + "description": "Get users.\n\nGet information about users in the native realm and built-in users.", "inherits": { "type": { "name": "RequestBase", @@ -191841,7 +191859,7 @@ } } ], - "specLocation": "security/get_user/SecurityGetUserRequest.ts#L23-L41" + "specLocation": "security/get_user/SecurityGetUserRequest.ts#L23-L44" }, { "kind": "response", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 3c4df835c7..818d5ec832 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -259,6 +259,7 @@ lowercase-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{bra mapping-date-format,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-date-format.html mapping-meta-field,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-meta-field.html mapping-metadata,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-fields.html +mapping-roles,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-roles.html mapping-settings-limit,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-settings-limit.html mapping-source-field,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping-source-field.html mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping.html @@ -570,6 +571,8 @@ security-api-saml-logout,https://www.elastic.co/guide/en/elasticsearch/reference security-api-saml-prepare-authentication,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-prepare-authentication.html security-api-saml-sp-metadata,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-saml-sp-metadata.html security-api-ssl,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-api-ssl.html +security-privileges,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/security-privileges.html +service-accounts,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/service-accounts.html set-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/set-processor.html shape,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/shape.html simulate-pipeline-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/simulate-pipeline-api.html diff --git a/specification/security/activate_user_profile/Request.ts b/specification/security/activate_user_profile/Request.ts index b8d0243c32..698ef10b0c 100644 --- a/specification/security/activate_user_profile/Request.ts +++ b/specification/security/activate_user_profile/Request.ts @@ -21,7 +21,9 @@ import { GrantType } from '@security/_types/GrantType' import { RequestBase } from '@_types/Base' /** - * Creates or updates a user profile on behalf of another user. + * Activate a user profile. + * + * Create or update a user profile on behalf of another user. * @rest_spec_name security.activate_user_profile * @availability stack since=8.2.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/authenticate/SecurityAuthenticateRequest.ts b/specification/security/authenticate/SecurityAuthenticateRequest.ts index 608f90d0be..66202c9440 100644 --- a/specification/security/authenticate/SecurityAuthenticateRequest.ts +++ b/specification/security/authenticate/SecurityAuthenticateRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' /** * 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. diff --git a/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts b/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts index 05377914b2..23e5358be6 100644 --- a/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts +++ b/specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base' import { Refresh } from '@_types/common' /** + * 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. * @rest_spec_name security.bulk_delete_role diff --git a/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts b/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts index ebeab2dc36..e9e89b2af3 100644 --- a/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts +++ b/specification/security/bulk_put_role/SecurityBulkPutRoleRequest.ts @@ -23,6 +23,8 @@ import { RequestBase } from '@_types/Base' import { Refresh } from '@_types/common' /** + * 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. * @rest_spec_name security.bulk_put_role diff --git a/specification/security/change_password/SecurityChangePasswordRequest.ts b/specification/security/change_password/SecurityChangePasswordRequest.ts index 52429e61fe..ee61611c22 100644 --- a/specification/security/change_password/SecurityChangePasswordRequest.ts +++ b/specification/security/change_password/SecurityChangePasswordRequest.ts @@ -21,6 +21,9 @@ import { RequestBase } from '@_types/Base' import { Password, Refresh, Username } from '@_types/common' /** + * Change passwords. + * + * Change the passwords of users in the native realm and built-in users. * @rest_spec_name security.change_password * @availability stack stability=stable */ diff --git a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts index 67c308fdc3..f631422320 100644 --- a/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts +++ b/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheRequest.ts @@ -21,7 +21,9 @@ import { RequestBase } from '@_types/Base' import { Ids } from '@_types/common' /** - * Evicts a subset of all entries from the API key cache. + * 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. * @rest_spec_name security.clear_api_key_cache * @availability stack since=7.10.0 stability=stable diff --git a/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts b/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts index 5b183a7ab0..7117880a7e 100644 --- a/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts +++ b/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesRequest.ts @@ -21,6 +21,10 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * 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. * @rest_spec_name security.clear_cached_privileges * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts b/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts index b87498885a..33e192a5aa 100644 --- a/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts +++ b/specification/security/clear_cached_realms/SecurityClearCachedRealmsRequest.ts @@ -21,6 +21,9 @@ import { RequestBase } from '@_types/Base' import { Names } from '@_types/common' /** + * Clear the user cache. + * + * Evict users from the user cache. You can completely clear the cache or evict specific users. * @rest_spec_name security.clear_cached_realms * @availability stack stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts b/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts index b84006af56..14c852513e 100644 --- a/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts +++ b/specification/security/clear_cached_roles/ClearCachedRolesRequest.ts @@ -21,6 +21,9 @@ import { RequestBase } from '@_types/Base' import { Names } from '@_types/common' /** + * Clear the roles cache. + * + * Evict roles from the native role cache. * @rest_spec_name security.clear_cached_roles * @availability stack stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts b/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts index af81d05f3f..a0f7f6eea2 100644 --- a/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts +++ b/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensRequest.ts @@ -21,9 +21,13 @@ import { RequestBase } from '@_types/Base' import { Names, Namespace, Service } from '@_types/common' /** + * Clear service account token caches. + * + * Evict a subset of all entries from the service account token caches. * @rest_spec_name security.clear_cached_service_tokens * @availability stack stability=stable * @availability serverless stability=stable visibility=private + * @ext_doc_id service-accounts */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts index e5f6f2bb89..3478245347 100644 --- a/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts +++ b/specification/security/create_api_key/SecurityCreateApiKeyRequest.ts @@ -25,7 +25,8 @@ import { Duration } from '@_types/Time' /** * Create an API key. - * Creates an API key for access without requiring basic authentication. + * + * 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. diff --git a/specification/security/create_service_token/CreateServiceTokenRequest.ts b/specification/security/create_service_token/CreateServiceTokenRequest.ts index ce6ed1fda2..06efbb0581 100644 --- a/specification/security/create_service_token/CreateServiceTokenRequest.ts +++ b/specification/security/create_service_token/CreateServiceTokenRequest.ts @@ -21,10 +21,13 @@ import { RequestBase } from '@_types/Base' import { Name, Namespace, Refresh, Service } from '@_types/common' /** - * Creates a service accounts token for access without requiring basic authentication. + * Create a service account token. + * + * Create a service accounts token for access without requiring basic authentication. * @rest_spec_name security.create_service_token * @availability stack stability=stable * @availability serverless stability=stable visibility=private + * @ext_doc_id service-accounts */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts b/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts index 782dafc6ab..472469b7ba 100644 --- a/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts +++ b/specification/security/delete_privileges/SecurityDeletePrivilegesRequest.ts @@ -21,9 +21,11 @@ import { RequestBase } from '@_types/Base' import { Name, Names, Refresh } from '@_types/common' /** + * Delete application privileges. * @rest_spec_name security.delete_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 { path_parts: { diff --git a/specification/security/delete_role/SecurityDeleteRoleRequest.ts b/specification/security/delete_role/SecurityDeleteRoleRequest.ts index fa4afc81df..e1b741da75 100644 --- a/specification/security/delete_role/SecurityDeleteRoleRequest.ts +++ b/specification/security/delete_role/SecurityDeleteRoleRequest.ts @@ -21,6 +21,9 @@ import { RequestBase } from '@_types/Base' import { Name, Refresh } from '@_types/common' /** + * Delete roles. + * + * Delete roles in the native realm. * @rest_spec_name security.delete_role * @availability stack stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts b/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts index c4551b64eb..36cb2c3a5c 100644 --- a/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts +++ b/specification/security/delete_role_mapping/SecurityDeleteRoleMappingRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { Name, Refresh } from '@_types/common' /** + * Delete role mappings. * @rest_spec_name security.delete_role_mapping * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/delete_service_token/DeleteServiceTokenRequest.ts b/specification/security/delete_service_token/DeleteServiceTokenRequest.ts index 9f424b628e..cb6a270a5f 100644 --- a/specification/security/delete_service_token/DeleteServiceTokenRequest.ts +++ b/specification/security/delete_service_token/DeleteServiceTokenRequest.ts @@ -21,9 +21,13 @@ import { RequestBase } from '@_types/Base' import { Name, Namespace, Refresh, Service } from '@_types/common' /** + * Delete service account tokens. + * + * Delete service account tokens for a service in a specified namespace. * @rest_spec_name security.delete_service_token * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=private + * @ext_doc_id service-accounts */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/delete_user/SecurityDeleteUserRequest.ts b/specification/security/delete_user/SecurityDeleteUserRequest.ts index 07217b16d0..9fe555c480 100644 --- a/specification/security/delete_user/SecurityDeleteUserRequest.ts +++ b/specification/security/delete_user/SecurityDeleteUserRequest.ts @@ -21,6 +21,9 @@ import { RequestBase } from '@_types/Base' import { Refresh, Username } from '@_types/common' /** + * Delete users. + * + * Delete users from the native realm. * @rest_spec_name security.delete_user * @availability stack stability=stable */ diff --git a/specification/security/disable_user/SecurityDisableUserRequest.ts b/specification/security/disable_user/SecurityDisableUserRequest.ts index 30c1447a4e..6159d114ca 100644 --- a/specification/security/disable_user/SecurityDisableUserRequest.ts +++ b/specification/security/disable_user/SecurityDisableUserRequest.ts @@ -21,6 +21,9 @@ import { RequestBase } from '@_types/Base' import { Refresh, Username } from '@_types/common' /** + * Disable users. + * + * Disable users in the native realm. * @rest_spec_name security.disable_user * @availability stack stability=stable */ diff --git a/specification/security/disable_user_profile/Request.ts b/specification/security/disable_user_profile/Request.ts index eb31d02362..4cdcd929e1 100644 --- a/specification/security/disable_user_profile/Request.ts +++ b/specification/security/disable_user_profile/Request.ts @@ -22,7 +22,9 @@ import { RequestBase } from '@_types/Base' import { Refresh } from '@_types/common' /** - * Disables a user profile so it's not visible in user profile searches. + * Disable a user profile. + * + * Disable user profiles so that they are not visible in user profile searches. * @rest_spec_name security.disable_user_profile * @availability stack since=8.2.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/enable_user/SecurityEnableUserRequest.ts b/specification/security/enable_user/SecurityEnableUserRequest.ts index 538d919407..372936212f 100644 --- a/specification/security/enable_user/SecurityEnableUserRequest.ts +++ b/specification/security/enable_user/SecurityEnableUserRequest.ts @@ -21,6 +21,9 @@ import { RequestBase } from '@_types/Base' import { Refresh, Username } from '@_types/common' /** + * Enable users. + * + * Enable users in the native realm. * @rest_spec_name security.enable_user * @availability stack stability=stable */ diff --git a/specification/security/enable_user_profile/Request.ts b/specification/security/enable_user_profile/Request.ts index fd06852d3c..b236cd5b94 100644 --- a/specification/security/enable_user_profile/Request.ts +++ b/specification/security/enable_user_profile/Request.ts @@ -22,7 +22,9 @@ import { RequestBase } from '@_types/Base' import { Refresh } from '@_types/common' /** - * Enables a user profile so it's visible in user profile searches. + * Enable a user profile. + * + * Enable user profiles to make them visible in user profile searches. * @rest_spec_name security.enable_user_profile * @availability stack since=8.2.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/enroll_kibana/Request.ts b/specification/security/enroll_kibana/Request.ts index 88db88ab7e..9dbf5ac3c7 100644 --- a/specification/security/enroll_kibana/Request.ts +++ b/specification/security/enroll_kibana/Request.ts @@ -20,7 +20,9 @@ import { RequestBase } from '@_types/Base' /** - * Enables a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. + * Enroll Kibana. + * + * Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. * @rest_spec_name security.enroll_kibana * @availability stack since=8.0.0 stability=stable */ diff --git a/specification/security/enroll_node/Request.ts b/specification/security/enroll_node/Request.ts index 1539d1820a..a9a5b78e32 100644 --- a/specification/security/enroll_node/Request.ts +++ b/specification/security/enroll_node/Request.ts @@ -20,7 +20,9 @@ import { RequestBase } from '@_types/Base' /** - * Allows a new node to join an existing cluster with security features enabled. + * Enroll a node. + * + * Enroll a new node to allow it to join an existing cluster with security features enabled. * @rest_spec_name security.enroll_node * @availability stack since=8.0.0 stability=stable */ diff --git a/specification/security/get_api_key/SecurityGetApiKeyRequest.ts b/specification/security/get_api_key/SecurityGetApiKeyRequest.ts index ed96c159f7..b090158aa4 100644 --- a/specification/security/get_api_key/SecurityGetApiKeyRequest.ts +++ b/specification/security/get_api_key/SecurityGetApiKeyRequest.ts @@ -22,6 +22,7 @@ import { Id, Name, Username } from '@_types/common' /** * 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. diff --git a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts index 646eef3bf9..6c2db327cc 100644 --- a/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts +++ b/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesRequest.ts @@ -20,9 +20,13 @@ import { RequestBase } from '@_types/Base' /** + * Get builtin privileges. + * + * Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. * @rest_spec_name security.get_builtin_privileges * @availability stack since=7.3.0 stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges manage_security + * @ext_doc_id security-privileges */ export interface Request extends RequestBase {} diff --git a/specification/security/get_privileges/SecurityGetPrivilegesRequest.ts b/specification/security/get_privileges/SecurityGetPrivilegesRequest.ts index 22dfc434a7..9c1dc0671e 100644 --- a/specification/security/get_privileges/SecurityGetPrivilegesRequest.ts +++ b/specification/security/get_privileges/SecurityGetPrivilegesRequest.ts @@ -21,9 +21,11 @@ import { RequestBase } from '@_types/Base' import { Name, Names } from '@_types/common' /** + * Get application privileges. * @rest_spec_name security.get_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 { path_parts: { diff --git a/specification/security/get_role/SecurityGetRoleRequest.ts b/specification/security/get_role/SecurityGetRoleRequest.ts index 2f0a9917a8..2e44f9164d 100644 --- a/specification/security/get_role/SecurityGetRoleRequest.ts +++ b/specification/security/get_role/SecurityGetRoleRequest.ts @@ -21,6 +21,9 @@ import { RequestBase } from '@_types/Base' import { Names } from '@_types/common' /** + * 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. * @rest_spec_name security.get_role diff --git a/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts b/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts index a6fba4d641..89af3fbd49 100644 --- a/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts +++ b/specification/security/get_role_mapping/SecurityGetRoleMappingRequest.ts @@ -21,10 +21,16 @@ import { RequestBase } from '@_types/Base' import { Names } from '@_types/common' /** + * 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. * @rest_spec_name security.get_role_mapping * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges manage_security + * @ext_doc_id mapping-roles */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/get_service_accounts/GetServiceAccountsRequest.ts b/specification/security/get_service_accounts/GetServiceAccountsRequest.ts index 298332b094..ba780e77c7 100644 --- a/specification/security/get_service_accounts/GetServiceAccountsRequest.ts +++ b/specification/security/get_service_accounts/GetServiceAccountsRequest.ts @@ -21,11 +21,14 @@ import { RequestBase } from '@_types/Base' import { Namespace, Service } from '@_types/common' /** - * This API returns a list of service accounts that match the provided path parameter(s). + * Get service accounts. + * + * Get a list of service accounts that match the provided path parameters. * @rest_spec_name security.get_service_accounts * @availability stack since=7.13.0 stability=stable * @availability serverless stability=stable visibility=private * @cluster_privileges manage_service_account + * @ext_doc_id service-accounts */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/get_service_credentials/GetServiceCredentialsRequest.ts b/specification/security/get_service_credentials/GetServiceCredentialsRequest.ts index 3211fb4cb9..fcb64f51eb 100644 --- a/specification/security/get_service_credentials/GetServiceCredentialsRequest.ts +++ b/specification/security/get_service_credentials/GetServiceCredentialsRequest.ts @@ -21,9 +21,11 @@ import { RequestBase } from '@_types/Base' import { Name, Namespace } from '@_types/common' /** + * Get service account credentials. * @rest_spec_name security.get_service_credentials * @availability stack since=7.13.0 stability=stable * @availability serverless stability=stable visibility=private + * @ext_doc_id service-accounts */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/security/get_token/GetUserAccessTokenRequest.ts b/specification/security/get_token/GetUserAccessTokenRequest.ts index 6fda3119f0..4e163fa9b9 100644 --- a/specification/security/get_token/GetUserAccessTokenRequest.ts +++ b/specification/security/get_token/GetUserAccessTokenRequest.ts @@ -23,6 +23,9 @@ import { Password, Username } from '@_types/common' import { AccessTokenGrantType } from './types' /** + * Get a token. + * + * Create a bearer token for access without requiring basic authentication. * @rest_spec_name security.get_token * @availability stack since=5.5.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/security/get_user/SecurityGetUserRequest.ts b/specification/security/get_user/SecurityGetUserRequest.ts index 0da3646956..376a497879 100644 --- a/specification/security/get_user/SecurityGetUserRequest.ts +++ b/specification/security/get_user/SecurityGetUserRequest.ts @@ -21,6 +21,9 @@ import { RequestBase } from '@_types/Base' import { Username } from '@_types/common' /** + * Get users. + * + * Get information about users in the native realm and built-in users. * @rest_spec_name security.get_user * @availability stack stability=stable */