Search + K

Command Palette

Search for a command to run...

Sign In

Create a service account token

POST /_security/service/{namespace}/{service}/credential/token/{name}
Copy endpoint

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.

Required authorization

  • Cluster privileges: manage_service_account

Parameters

path Path Parameters

Name Type
namespace required

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

type TypesNamespace = string
service required

The name of the service.

type TypesService = string
name required

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>.

type TypesName = string

query Query Parameters

Name Type
refresh

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.

type TypesRefresh = "true" | "false" | "wait_for"

Responses

200 application/json
{ created: boolean;token: SecurityCreateServiceTokenToken
interface SecurityCreateServiceTokenToken {
name: TypesName;
value: string;
}
; }