Credentials

Exchange an API key for a short-lived access token

POST /api/v1/auth/access-token

Operation

access_tokens.exchange

Accepts

apiKey

Effect

changing

Rate class

auth

Answers

• 200 The result

  application/json: ExchangeApiKeyResponse

• 400 BAD_REQUEST: The request cannot be read.
• 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
• 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
• 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
• 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
• 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
• 500 INTERNAL: The instance failed. The message never carries details.

Issue a session token for a user of a trusted backend

POST /api/v1/instance/session-tokens

Operation

session_tokens.issue

Accepts

serverCredential

Effect

changing

Rate class

read

Request body

application/json: IssueSessionTokenRequestInput

Answers

• 200 The result

  application/json: IssueSessionTokenResponse

• 400 BAD_REQUEST: The request cannot be read.
• 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
• 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
• 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
• 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
• 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
• 500 INTERNAL: The instance failed. The message never carries details.