Sign in
OAuth

Initiate OAuth authorization

OAuth 2.1 authorization endpoint. The client opens the browser at this URL; valid requests are redirected to the frontend consent page where the user approves access.

get/public/v1/oauth/authorize/

Query parameters

client_idstring required

The client_id returned during client registration.

redirect_uristring required

The URI to redirect to after authorization. Must match one of the registered redirect URIs.

response_typestring required

Must be code.

code_challengestring required

PKCE code challenge. Base64url-encoded SHA-256 hash of the code verifier.

code_challenge_methodstring

PKCE method. Only S256 is supported. Defaults to S256 if omitted.

scopestring

Space-separated list of requested scopes. Available value: all. Defaults to the full set of scopes granted during registration if omitted.

statestring

Opaque value to maintain state between the request and the callback. Returned unchanged in the redirect.

resourcestring

RFC 8707 resource indicator — the canonical URI of the API this token will be used against. Forwarded through consent and bound to the issued token.

Changes

Changed in 1 of the 3 revisions of this API.13

  • 87e654ac822e13See the full diff
    • ○

      added the media type application/json for the response with the status 400

      response-media-type-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the optional property active_batches to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property available_credits to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property current_status to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property error to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property max_allowed to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property required_minimum to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property response_meta to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property retry_after to the response with the 401 status

      response-optional-property-added

    • ○

      added the required property error_code to the response with the 401 status

      response-required-property-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog