Component schema

OAuthTokenRequest

object1 direct reference

Definition

object

OAuthGrantTyperequired

authorization_code: The standard authorization code grant (RFC 6749 section 4.1).
refresh_token: Exchange a refresh token for new tokens (RFC 6749 section 6).

"authorization_code""refresh_token"

string

The authorization code (required for authorization_code grant).

string

Must match the redirect_uri used in the authorization request (required for authorization_code grant).

string

The client identifier.

string

PKCE code verifier (required for authorization_code grant). All public clients must use PKCE (RFC 7636).

string

The refresh token (required for refresh_token grant).

string

Space-separated list of requested scopes. For refresh_token grant, must be equal to or a subset of the originally granted scopes.

Used by 1

These schemas and endpoints reference this type directly.

EndpointPOST /oauth/token

json

OpenAPI source123456789101112131415161718192021222324252627282930313233343536
{
  "type": "object",
  "properties": {
    "grant_type": {
      "$ref": "#/components/schemas/OAuthGrantType"
    },
    "code": {
      "description": "The authorization code (required for authorization_code grant).",
      "type": "string"
    },
    "redirect_uri": {
      "description": "Must match the redirect_uri used in the authorization request (required for authorization_code grant).",
      "type": "string",
      "format": "uri"
    },
    "client_id": {
      "description": "The client identifier.",
      "type": "string"
    },
    "code_verifier": {
      "description": "PKCE code verifier (required for authorization_code grant). All public clients must use PKCE (RFC 7636).",
      "type": "string"
    },
    "refresh_token": {
      "description": "The refresh token (required for refresh_token grant).",
      "type": "string"
    },
    "scope": {
      "description": "Space-separated list of requested scopes. For refresh_token grant, must be equal to or a subset of the originally granted scopes.",
      "type": "string"
    }
  },
  "required": [
    "grant_type"
  ]
}