OAuth 2.0

Authorize

Starts the Authorization Code grant at the authorization endpoint. Redirect the User's browser to this endpoint. The User signs in, then approves or denies the request.

Proof then redirects to your redirect_uri per response_mode, carrying code and state on approval or error and error_description on denial. Every redirect also carries iss, the issuer identifier of this authorization server. Compare it to issuer from GET /.well-known/oauth-authorization-server and reject the response when they differ. Exchange the code at POST /oauth/v2/token within 10 minutes.

An unknown client_id or an unregistered redirect_uri sends the User to a Proof-hosted error page. Redirected errors use invalid_scope, invalid_target, access_denied and invalid_request.

get/oauth/v2/authorize

Request

  • Base URL
    https://api.proof.com
  • URL
    https://api.proof.com/oauth/v2/authorize
  • Auth
    none declared

Query parameters

client_idstring required

Your client_id.

redirect_uristring required

A redirect URI registered on your OAuth application. Receives the authorization response.

response_type'code' required
scopestring required

Space-separated scope values requested from the User. GET /.well-known/oauth-authorization-server lists the supported scopes.

statestring

An opaque state value, returned unchanged on the redirect.

response_mode'query' | 'fragment' | 'form_post'

The response mode for the authorization response. Defaults to query. form_post returns an auto-submitting HTML form.

code_challengestring
code_challenge_method'S256'

How code_challenge was derived. Required alongside code_challenge.

Changes

No recorded changes to this operation across all 1 revision of this API.