Class TokensClient

Index

Constructors

Methods

createToken listTokens revokeToken updateToken

Constructors

constructor

new TokensClient(options: ClientOptions): TokensClient
Parameters
- options: ClientOptions
Returns TokensClient
- Defined in client.ts:57

Methods

createToken

createToken(
req: CreateTokenRequest,
options?: CallOptions,
): Promise<CreateTokenResponse>
Creates and returns a token for a user. If this call is made through token authentication, it creates a token with the same client ID as the authenticated token. If the user's token quota is exceeded, this call returns an error QUOTA_EXCEEDED.
Parameters
- req: CreateTokenRequest
- Optionaloptions: CallOptions
Returns Promise<CreateTokenResponse>
- Defined in client.ts:77

listTokens

listTokens(
_req: ListTokensRequest,
options?: CallOptions,
): Promise<ListTokensResponse>
Lists all the valid tokens for a user-workspace pair.
Parameters
- _req: ListTokensRequest
- Optionaloptions: CallOptions
Returns Promise<ListTokensResponse>
- Defined in client.ts:107

revokeToken

revokeToken(
req: RevokeTokenRequest,
options?: CallOptions,
): Promise<RevokeTokenResponse>
Revokes an access token.

If a token with the specified ID is not valid, this call returns an error RESOURCE_DOES_NOT_EXIST.
Parameters
- req: RevokeTokenRequest
- Optionaloptions: CallOptions
Returns Promise<RevokeTokenResponse>
- Defined in client.ts:140

updateToken

updateToken(
req: UpdateTokenRequest,
options?: CallOptions,
): Promise<UpdateTokenResponse>
Updates the comment or scopes of a token.

If a token with the specified ID is not valid, this call returns an error NOT_FOUND.
Parameters
- req: UpdateTokenRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateTokenResponse>
- Defined in client.ts:174