Sign in
Auth

Refresh WorkOS token bundle

Refreshes a WorkOS AuthKit access token using the server-held WorkOS API key.

post/v1/auth/workos/refresh

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/auth/workos/refresh
  • Auth: none declared

Request body

refreshTokenstring required

Refresh token previously returned by the WorkOS broker.

Example request

{
  "refreshToken": "refresh_token_123"
}

Response

Refreshed WorkOS token bundle.

access_tokenstring required

JWT access token used as Authorization: Bearer for authenticated Solomon AI API calls.

emailstring nullable

Best-known WorkOS primary email for the user.

expires_atinteger required

Unix timestamp in seconds when the access token expires.

refresh_tokenstring nullable

Refresh token for obtaining a new WorkOS access token.

token_type'Bearer' required

Token type.

user_idstring nullable

WorkOS user id when available.

Example response

{
  "access_token": "example-access-token",
  "email": "user@example.com",
  "expires_at": 1790784000,
  "refresh_token": "refresh_token_123",
  "token_type": "Bearer",
  "user_id": "user_01HABCDEF"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.