REST Resource: projects.locations.clusters.tokenAuthUsers.authTokens

Resource: AuthToken

Auth token for the cluster.

JSON representation
{
  "name": string,
  "token": string,
  "createTime": string,
  "state": enum (State)
}
Fields
name

string

Identifier. Name of the auth token. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{tokenAuthUser}/authTokens/{authToken}

token

string

Output only. The service generated authentication token used to connect to the Redis cluster.

createTime

string (Timestamp format)

Output only. Create time of the auth token.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

state

enum (State)

Output only. State of the auth token.

State

Represents the different states of an auth token. New values may be added in the future.

Enums
STATE_UNSPECIFIED Not set.
ACTIVE The auth token is active.
CREATING The auth token is being created.
DELETING The auth token is being deleted.

Methods

delete

Removes a auth token for a user of a token based auth enabled instance.

get

Gets a specific auth token for a specific token auth user.

list

Lists all the auth tokens for a specific token auth user.