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.
70 endpoints
-
Reset the project encryption key
- POST /_encryption/_reset
-
Activate a user profile
- POST /_security/profile/_activate
-
Authenticate a user
- GET /_security/_authenticate
-
Bulk create or update roles
- POST /_security/role
-
Bulk delete roles
- DELETE /_security/role
-
Bulk update API keys
- POST /_security/api_key/_bulk_update
-
Change passwords
- POST also PUT /_security/user/{username}/_password
-
Clear the API key cache
- POST /_security/api_key/{ids}/_clear_cache
-
Clear the privileges cache
- POST /_security/privilege/{application}/_clear_cache
-
Clear the user cache
- POST /_security/realm/{realms}/_clear_cache
-
Clear the roles cache
- POST /_security/role/{name}/_clear_cache
-
Clear service account token caches
- POST /_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache
-
Clone an API key
- POST also PUT /_security/api_key/clone
-
Get API key information
- GET /_security/api_key
-
Create an API key
- POST also PUT /_security/api_key
-
Invalidate API keys
- DELETE /_security/api_key
-
Create a cross-cluster API key
- POST /_security/cross_cluster/api_key
-
Create a service account token
- POST also PUT /_security/service/{namespace}/{service}/credential/token/{name}
-
Delete service account tokens
- DELETE /_security/service/{namespace}/{service}/credential/token/{name}
-
Delegate PKI authentication
- POST /_security/delegate_pki
-
Get application privileges
- GET /_security/privilege/{application}/{name}
-
Delete application privileges
- DELETE /_security/privilege/{application}/{name}
-
Get roles
- GET /_security/role/{name}
-
Create or update roles
- POST also PUT /_security/role/{name}
-
Delete roles
- DELETE /_security/role/{name}
-
Get role mappings
- GET /_security/role_mapping/{name}
-
Create or update role mappings
- POST also PUT /_security/role_mapping/{name}
-
Delete role mappings
- DELETE /_security/role_mapping/{name}
-
Get users
- GET /_security/user/{username}
-
Create or update users
- POST also PUT /_security/user/{username}
-
Delete users
- DELETE /_security/user/{username}
-
Get service accounts
- GET /_security/service/{namespace}/{service}
-
Create user-managed service accounts
- PUT /_security/service/{namespace}/{service}
-
Delete user-managed service accounts
- DELETE /_security/service/{namespace}/{service}
-
Disable users
- POST also PUT /_security/user/{username}/_disable
-
Disable a user profile
- POST also PUT /_security/profile/{uid}/_disable
-
Enable users
- POST also PUT /_security/user/{username}/_enable
-
Enable a user profile
- POST also PUT /_security/profile/{uid}/_enable
-
Enroll Kibana
- GET /_security/enroll/kibana
-
Enroll a node
- GET /_security/enroll/node
-
Get builtin privileges
- GET /_security/privilege/_builtin
-
Get service account credentials
- GET /_security/service/{namespace}/{service}/credential
-
Get security index settings
- GET /_security/settings
-
Update security index settings
- PUT /_security/settings
-
Get security stats
- GET /_security/stats
-
Get a token
- POST /_security/oauth2/token
-
Invalidate a token
- DELETE /_security/oauth2/token
-
Get user privileges
- GET /_security/user/_privileges
-
Get a user profile
- GET /_security/profile/{uid}
-
Grant an API key
- POST /_security/api_key/grant
-
Check user privileges
- POST also GET /_security/user/{user}/_has_privileges
-
Check user profile privileges
- POST also GET /_security/profile/_has_privileges
-
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
- POST also PUT /_security/privilege
-
Find API keys with a query
- POST also GET /_security/_query/api_key
-
Find roles with a query
- POST also GET /_security/_query/role
-
Find users with a query
- POST also GET /_security/_query/user
-
Authenticate SAML
- POST /_security/saml/authenticate
-
Logout of SAML completely
- POST /_security/saml/complete_logout
-
Invalidate SAML
- POST /_security/saml/invalidate
-
Logout of SAML
- POST /_security/saml/logout
-
Prepare SAML authentication
- POST /_security/saml/prepare
-
Create SAML service provider metadata
- GET /_security/saml/metadata/{realm_name}
-
Suggest a user profile
- POST also GET /_security/profile/_suggest
-
Update an API key
- PUT /_security/api_key/{id}
-
Update a cross-cluster API key
- PUT /_security/cross_cluster/api_key/{id}
-
Update user profile data
- POST also PUT /_security/profile/{uid}/_data
-
Get SSL certificates
- GET /_ssl/certificates