token_auth_users

Creates, updates, deletes, gets or lists a token_auth_users resource.

Overview

Name	token_auth_users
Type	Resource
Id	google.redis.token_auth_users

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the token based auth user. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}
state	string	Output only. The state of the token based auth user. (STATE_UNSPECIFIED, ACTIVE, CREATING, UPDATING, DELETING)

list

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, clustersId, tokenAuthUsersId		Gets a specific token auth user for a basic auth enabled cluster.
list	select	projectsId, locationsId, clustersId	filter, pageSize, pageToken, orderBy	Lists all the token auth users for a token based auth enabled cluster.
delete	delete	projectsId, locationsId, clustersId, tokenAuthUsersId	requestId, force	Deletes a token auth user for a token based auth enabled cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
clustersId	string
locationsId	string
projectsId	string
tokenAuthUsersId	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets a specific token auth user for a basic auth enabled cluster.

SELECT
name,
state
FROM google.redis.token_auth_users
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
AND tokenAuthUsersId = '{{ tokenAuthUsersId }}' -- required
;

list

Lists all the token auth users for a token based auth enabled cluster.

SELECT
*
FROM google.redis.token_auth_users
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
;

DELETE examples

delete

Deletes a token auth user for a token based auth enabled cluster.

DELETE FROM google.redis.token_auth_users
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND tokenAuthUsersId = '{{ tokenAuthUsersId }}' --required
AND requestId = '{{ requestId }}'
AND force = '{{ force }}'
;