OAuth2

Authorize User

get/oauth/authorize

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/oauth/authorize
  • Auth: none declared

Query parameters

response_typestring required

Use code for server side flows, and token for application side flows

client_idstring required

Application client_id

statestring

An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the application. This value must be used by the application to prevent CSRF attacks.

scopestring required

A space-delimited list of permissions that the application requires.

redirect_uristring required

The URL to which Auth will redirect the browser after authorization has been granted by the user.

code_challengestring

The code challenge used to verify the code_challenge during the token exchange.

code_challenge_methodstring

The method used to encode the code_challenge parameter. This is used to verify the code_challenge during the token exchange.

prompt'login'

Prompt parameter to force re-authentication. Use "login" to ignore any existing user session and force login.

Changes

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