client.authorizationOperation 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.
/auth/cli/storage-compensationauthorization.compensateCliStorage
Revokes the exact personal credential issued by a recently consumed TeamGrid CLI browser-authorization grant when the operating-system credential store rejects that credential. The just-issued credential authenticates this request; the grant ID is not an independent authority and cannot select any other credential. The recovery window is short and the operation is intended only for automatic CLI cleanup.
client.authorization.compensateCliStorage(grantId: string, options: RequestOptions = {})- Return form
Promise- Operation ID
compensateCliAuthorizationStorage- Required scopes
- None
- SDK parameters
grantId: stringoptions: RequestOptions- Request body
objectapplication/json- Success
204
/auth/contextauthorization.getContext
Returns only the safe metadata of the credential authenticating this request. This operation deliberately requires no additional scope so even a least-privilege credential can diagnose its own routing and expiry.
client.authorization.getContext(options: RequestOptions = {})- Return form
Promise- Operation ID
getCurrentCredentialContext- Required scopes
- None
- SDK parameters
options: RequestOptions- Success
200 CredentialContext envelope
/auth/contextauthorization.revokeCurrentCredential
Permanently revokes exactly the credential authenticating this request. A retry after a confirmed response is expected to receive 401 because the bearer credential is no longer valid.
client.authorization.revokeCurrentCredential(options: RequestOptions = {})- Return form
Promise- Operation ID
revokeCurrentCredential- Required scopes
- None
- SDK parameters
options: RequestOptions- Success
204
Errors 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.