OAuth 2.0 Authorize Endpoint

This endpoint is used to start the authorization process. The client redirects the user to this endpoint to request authorization. The user will be prompted to log in and grant permission to the client application.

Use open source libraries to perform OAuth 2.0 and OpenID Connect available for any programming language. You can find a list of libraries at https://oauth.net/code/

For now, you can only use grant_type authorization_code and refresh_token in the /oauth2/token endpoint

Query Parameters

response_type string required

Possible values: [code, token, id_token, code token]

The type of response expected from the OAuth2 server

client_id string required

The client id that you already created

redirect_uri string required

Where to redirect after the oauth2 process completed

scope string required

The scopes that you want to request, separated by spaces

state string

An opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client.

Responses

• 302
• 400

---

Redirect to the client's redirect URI

Response Headers

• Location string

  The URL to redirect the user to, including the authorization code or error information

Bad request

application/json

Schema

Example (from schema)

---

Schema

error string

Error code

error_debug string

Error Debug Information

Only available in dev mode.

error_description string

Human-readable ASCII text providing additional information about the error

error_hint string

Error Hint

Helps the user identify the error cause.

status_code int64

HTTP Status Code

{
  "error": "invalid_client",
  "error_debug": "string",
  "error_description": "Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method). The requested OAuth 2.0 Client does not exist.",
  "error_hint": "The redirect URL is not allowed.",
  "status_code": 401
}

Loading...