Type to search.

stack es security cli namespace

Serverless Preview

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack Preview

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Shell 
elastic stack es security --help

Elasticsearch security API commands

activate-user-profile

Activate a user profile.

 authenticate

Authenticate a user.

 bulk-delete-role

Bulk delete roles.

 bulk-put-role

Bulk create or update roles.

 bulk-update-api-keys

Bulk update API keys.

 change-password

Change passwords.

 clear-api-key-cache

Clear the API key cache.

 clear-cached-privileges

Clear the privileges cache.

 clear-cached-realms

Clear the user cache.

 clear-cached-roles

Clear the roles cache.

 clear-cached-service-tokens

Clear service account token caches.

 clone-api-key

Clone an API key.

 create-api-key

Create an API key.

 create-cross-cluster-api-key

Create a cross-cluster API key.

 create-service-token

Create a service account token.

 delegate-pki

Delegate PKI authentication.

 delete-privileges

Delete application privileges.

 delete-role

Delete roles.

 delete-role-mapping

Delete role mappings.

 delete-service-token

Delete service account tokens.

 delete-user

Delete users.

 delete-user-managed-service-account

Delete user-managed service accounts.

 disable-user

Disable users.

 disable-user-profile

Disable a user profile.

 enable-user

Enable users.

 enable-user-profile

Enable a user profile.

 enroll-kibana

Enroll Kibana.

 enroll-node

Enroll a node.

 get-api-key

Get API key information.

 get-builtin-privileges

Get builtin privileges.

 get-privileges

Get application privileges.

 get-role

Get roles.

 get-role-mapping

Get role mappings.

 get-service-accounts

Get service accounts.

 get-service-credentials

Get service account credentials.

 get-settings

Get security index settings.

 get-stats

Get security stats.

 get-token

Get a token.

 get-user

Get users.

 get-user-privileges

Get user privileges.

 get-user-profile

Get a user profile.

 grant-api-key

Grant an API key.

 has-privileges

Check user privileges.

 has-privileges-user-profile

Check user profile privileges.

 invalidate-api-key

Invalidate API keys.

 invalidate-token

Invalidate a token.

 oidc-authenticate

Authenticate OpenID Connect.

 oidc-logout

Logout of OpenID Connect.

 oidc-prepare-authentication

Prepare OpenID connect authentication.

 put-privileges

Create or update application privileges.

 put-role

Create or update roles.

 put-role-mapping

Create or update role mappings.

 put-user

Create or update users.

 put-user-managed-service-account

Create user-managed service accounts.

 query-api-keys

Find API keys with a query.

 query-role

Find roles with a query.

 query-user

Find users with a query.

 saml-authenticate

Authenticate SAML.

 saml-complete-logout

Logout of SAML completely.

 saml-invalidate

Invalidate SAML.

 saml-logout

Logout of SAML.

 saml-prepare-authentication

Prepare SAML authentication.

 saml-service-provider-metadata

Create SAML service provider metadata.

 suggest-user-profiles

Suggest a user profile.

 update-api-key

Update an API key.

 update-cross-cluster-api-key

Update a cross-cluster API key.

 update-settings

Update security index settings.

 update-user-profile-data

Update user profile data.