Security
The security APIs enable you to perform security activities, and add, update, retrieve, and remove application privileges, role mappings, and roles. You can also create and update API keys and create and invalidate bearer tokens.
-
Reset the project encryption key
Stack
Experimental
9.5+
- POST /_encryption/_reset
-
Authenticate a user
Stack
5.5+
- GET /_security/_authenticate
-
Find API keys with a query
Stack
7.15+
- POST also GET /_security/_query/api_key
-
Find roles with a query
Stack
8.15+
- POST also GET /_security/_query/role
-
Find users with a query
Stack
8.14+
- POST also GET /_security/_query/user
-
Get API key information
Stack
6.7+
- GET /_security/api_key
-
Create an API key
Stack
6.7+
- POST also PUT /_security/api_key
-
Invalidate API keys
Stack
6.7+
- DELETE /_security/api_key
-
Bulk update API keys
Stack
8.5+
- POST /_security/api_key/_bulk_update
-
Clone an API key
Stack
Experimental
9.4+
- POST also PUT /_security/api_key/clone
-
Grant an API key
Stack
7.9+
- POST /_security/api_key/grant
-
Clear the API key cache
Stack
7.10+
- POST /_security/api_key/{ids}/_clear_cache
-
Update an API key
Stack
8.4+
- PUT /_security/api_key/{id}
-
Create a cross-cluster API key
- POST /_security/cross_cluster/api_key
-
Update a cross-cluster API key
- PUT /_security/cross_cluster/api_key/{id}
-
Delegate PKI authentication
Stack
7.4+
- POST /_security/delegate_pki
-
Enroll Kibana
Stack
8.0+
- GET /_security/enroll/kibana
-
Enroll a node
Stack
8.0+
- GET /_security/enroll/node
-
Get a token
Stack
5.5+
- POST /_security/oauth2/token
-
Invalidate a token
Stack
5.5+
- DELETE /_security/oauth2/token
-
Authenticate OpenID Connect
- POST /_security/oidc/authenticate
-
Logout of OpenID Connect
- POST /_security/oidc/logout
-
Prepare OpenID connect authentication
- POST /_security/oidc/prepare
-
Create or update application privileges
Stack
6.4+
- POST also PUT /_security/privilege
-
Get builtin privileges
Stack
7.3+
- GET /_security/privilege/_builtin
-
Clear the privileges cache
Stack
7.9+
- POST /_security/privilege/{application}/_clear_cache
-
Get application privileges
Stack
6.4+
- GET /_security/privilege/{application}/{name}
-
Delete application privileges
Stack
6.4+
- DELETE /_security/privilege/{application}/{name}
-
Activate a user profile
Stack
8.2+
- POST /_security/profile/_activate
-
Check user profile privileges
Stack
8.3+
- POST also GET /_security/profile/_has_privileges
-
Suggest a user profile
Stack
8.2+
- POST also GET /_security/profile/_suggest
-
Get a user profile
Stack
8.2+
- GET /_security/profile/{uid}
-
Update user profile data
Stack
8.2+
- POST also PUT /_security/profile/{uid}/_data
-
Disable a user profile
Stack
8.2+
- POST also PUT /_security/profile/{uid}/_disable
-
Enable a user profile
Stack
8.2+
- POST also PUT /_security/profile/{uid}/_enable
-
Clear the user cache
- POST /_security/realm/{realms}/_clear_cache
-
Bulk create or update roles
Stack
8.15+
- POST /_security/role
-
Bulk delete roles
Stack
8.15+
- DELETE /_security/role
-
Get roles
- GET /_security/role/{name}
-
Create or update roles
- POST also PUT /_security/role/{name}
-
Delete roles
- DELETE /_security/role/{name}
-
Clear the roles cache
- POST /_security/role/{name}/_clear_cache
-
Get role mappings
Stack
5.5+
- GET /_security/role_mapping/{name}
-
Create or update role mappings
Stack
5.5+
- POST also PUT /_security/role_mapping/{name}
-
Delete role mappings
Stack
5.5+
- DELETE /_security/role_mapping/{name}
-
Authenticate SAML
Stack
7.5+
- POST /_security/saml/authenticate
-
Logout of SAML completely
Stack
7.14+
- POST /_security/saml/complete_logout
-
Invalidate SAML
Stack
7.5+
- POST /_security/saml/invalidate
-
Logout of SAML
Stack
7.5+
- POST /_security/saml/logout
-
Create SAML service provider metadata
Stack
7.11+
- GET /_security/saml/metadata/{realm_name}
-
Prepare SAML authentication
Stack
7.5+
- POST /_security/saml/prepare
-
Get service accounts
Stack
7.13+
- GET /_security/service/{namespace}/{service}
-
Create user-managed service accounts
Stack
Planned
- PUT /_security/service/{namespace}/{service}
-
Delete user-managed service accounts
Stack
Planned
- DELETE /_security/service/{namespace}/{service}
-
Get service account credentials
Stack
7.13+
- GET /_security/service/{namespace}/{service}/credential
-
Create a service account token
- POST also PUT /_security/service/{namespace}/{service}/credential/token/{name}
-
Delete service account tokens
Stack
5.5+
- DELETE /_security/service/{namespace}/{service}/credential/token/{name}
-
Clear service account token caches
- POST /_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache
-
Get security index settings
- GET /_security/settings
-
Update security index settings
- PUT /_security/settings
-
Get security stats
Stack
9.2+
- GET /_security/stats
-
Get user privileges
Stack
6.5+
- GET /_security/user/_privileges
-
Get users
- GET /_security/user/{username}
-
Create or update users
- POST also PUT /_security/user/{username}
-
Delete users
- DELETE /_security/user/{username}
-
Disable users
- POST also PUT /_security/user/{username}/_disable
-
Enable users
- POST also PUT /_security/user/{username}/_enable
-
Change passwords
- POST also PUT /_security/user/{username}/_password
-
Check user privileges
Stack
6.4+
- POST also GET /_security/user/{user}/_has_privileges
-
Get SSL certificates
Stack
6.2+
- GET /_ssl/certificates