Sign in
latestOpenAPI 3.0.32026-08-084947174.1 KB

f9302ec2ef8a

OAuth2

OAuth2 Authorize

Direct the user to this endpoint to initiate the OAuth2 authorization code flow. Once the user has logged in, they will be redirected to your specified redirect_uri with a code parameter.

get/oauth/authorize

Query parameters

response_type'code' required

OAuth2 response type. Must be code.

client_idstring required

The client id provided when you requested access to the API.

redirect_uristring uri required

Where to send the code; the same URI you provided when you requested access to the api. Used when authorizing and when using a grant_type of authorization_code.

scope'admin' required

Requested OAuth2 scopes. Currently only admin is supported.

statestring

An opaque value you can set to protect against CSRF attacks.

Response

Success