Create a service account token

POST also PUT /_security/service/{namespace}/{service}/credential/token/{name}
POST /_security/service/{namespace}/{service}/credential/token

Auth

Create a service accounts token for access without requiring basic authentication.

Note

Service account tokens never expire. You must actively delete them if they are no longer needed.

Read the reference documentation

Required privileges

Cluster privileges manage_service_account

Path parameters

namespace string required

The name of the namespace, which is a top-level grouping of service accounts.

service string required

The name of the service.

name string optional

The name for the service account token. If omitted, a random name will be generated.

Token names must be at least one and no more than 256 characters. They can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (-), and underscores (_), but cannot begin with an underscore.

Note

Token names must be unique in the context of the associated service account. They must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as <namespace>/<service>/<token-name>.

Leave it out to use /_security/service/{namespace}/{service}/credential/token.

Query parameters

refresh enum: If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.; Values: true false wait_for

Response

application/json

created boolean required
token object required