client.personalAccessTokensOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/me/personal-access-tokenspersonalAccessTokens.list
Use this operation to list personal access tokens owned by the current user. It returns only resources visible to the credential and applies the documented filters before producing a bounded, stable page. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.personalAccessTokens.list(options?: ListOptions)- Return form
Promise- Operation ID
listPersonalAccessTokens- Required scopes
credentials:read- SDK parameters
options: ListOptions- Query request fields
cursor?: stringlimit?: integer- Success
200 Array<PersonalAccessToken> envelope
/me/personal-access-tokenspersonalAccessTokens.create
Creates native v2 key material in the credential home cell. The token is returned only by this private no-store response and exact idempotent replays retained for seven days.
client.personalAccessTokens.create(data: PersonalAccessTokenCreate, options: MutationOptions = {})- Return form
Promise- Operation ID
createPersonalAccessToken- Required scopes
credentials:write- SDK parameters
data: PersonalAccessTokenCreateoptions: MutationOptions- Header request fields
Idempotency-Key: string- Request body
PersonalAccessTokenCreateapplication/json- Success
200 PersonalAccessToken envelope201 PersonalAccessToken envelope
/me/personal-access-tokens/{id}/rotationpersonalAccessTokens.rotate
Issues one successor generation, places the predecessor in a bounded retiring grace period, and reveals the successor only in this no-store response or an exact idempotent replay.
client.personalAccessTokens.rotate(id: string, data: PersonalAccessTokenRotation = {}, options: MutationOptions = {})- Return form
Promise- Operation ID
rotatePersonalAccessToken- Required scopes
credentials:write- SDK parameters
id: stringdata: PersonalAccessTokenRotationoptions: MutationOptions- Header request fields
Idempotency-Key: string- Request body
PersonalAccessTokenRotationapplication/json- Success
200 PersonalAccessToken envelope201 PersonalAccessToken envelope
/me/personal-access-tokens/{id}personalAccessTokens.revoke
Use this operation to revoke a personal access token. The operation preserves TeamGrid lifecycle and permission rules instead of bypassing them with a direct data deletion. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.personalAccessTokens.revoke(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
revokePersonalAccessToken- Required scopes
credentials:write- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
204
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
personalAccessTokens.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.personalAccessTokens.pages(options?: ListOptions, pagination?: PaginationOptions)AsyncGeneratorErrors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.