2026-04-03
▼ ▲ redis.projects.locations.clusters.addTokenAuthUser
Path : v1/{+cluster}:addTokenAuthUser
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:addTokenAuthUser
HTTP Method : POST
Parameters :
cluster
Description : Required. The cluster resource that this token auth user will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : cluster
Scopes :
Description : Adds a token auth user for a token based auth enabled cluster.
▼ ▲ redis.projects.locations.clusters.tokenAuthUsers.list
Path : v1/{+parent}/tokenAuthUsers
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource that this token based auth user will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's The maximum value is 1000; values above 1000 will be coerced to 1000. `next_page_token` to determine if there are more clusters left to be queried.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any.
Location : query
Type : string
filter
Description : Optional. Expression for filtering results.
Location : query
Type : string
orderBy
Description : Optional. Sort results by a defined order.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists all the token auth users for a token based auth enabled cluster.
▼ ▲ redis.projects.locations.clusters.tokenAuthUsers.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of token auth user for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets a specific token auth user for a basic auth enabled cluster.
▼ ▲ redis.projects.locations.clusters.tokenAuthUsers.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
force
Description : Optional. If set to true, any child auth tokens of this user will also be deleted. Otherwise, the request will only work if the user has no auth tokens.
Location : query
Type : boolean
Parameter Order : name
Scopes :
Description : Deletes a token auth user for a token based auth enabled cluster.
▼ ▲ redis.projects.locations.clusters.tokenAuthUsers.addAuthToken
Path : v1/{+tokenAuthUser}:addAuthToken
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}:addAuthToken
HTTP Method : POST
Parameters :
tokenAuthUser
Description : Required. The name of the token auth user resource that this auth token will be added for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : tokenAuthUser
Scopes :
Description : Adds a auth token for a user of a token based auth enabled cluster.
▼ ▲ redis.projects.locations.clusters.tokenAuthUsers.authTokens.list
Path : v1/{+parent}/authTokens
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}/authTokens
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource that this auth token will be listed for. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of items to return. The maximum value is 1000; values above 1000 will be coerced to 1000. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The `next_page_token` value returned from a previous [ListTokenAuthUsers] request, if any.
Location : query
Type : string
filter
Description : Optional. Expression for filtering results.
Location : query
Type : string
orderBy
Description : Optional. Sort results by a defined order.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists all the auth tokens for a specific token auth user.
▼ ▲ redis.projects.locations.clusters.tokenAuthUsers.authTokens.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}/authTokens/{authTokensId}
HTTP Method : GET
Parameters :
name
Description : Required. The name of auth token for a token based auth enabled cluster. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+/authTokens/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets a specific auth token for a specific token auth user.
▼ ▲ redis.projects.locations.clusters.tokenAuthUsers.authTokens.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/tokenAuthUsers/{tokenAuthUsersId}/authTokens/{authTokensId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The name of the token auth user resource that this auth token will be deleted from. Format: projects/{project}/locations/{location}/clusters/{cluster}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}
Pattern : ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/tokenAuthUsers/[^/]+/authTokens/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Removes a auth token for a user of a token based auth enabled instance.