Check an OAuth authorization request and describe it for the consent screen.

POST

/oauth/authorize/start

curl --request POST \
  --url https://api.siteqwality.com/oauth/authorize/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "client_id": "example", "redirect_uri": "example", "response_type": "example", "scopes": [ "example" ], "prompt": "example" }'

• Production

Authorizations

• bearer_auth

Request Body ^required

Media type application/json

The OAuth request the consent page received, passed through for checking.

object

client_id

required

string

redirect_uri

required

string

response_type

required

string

scopes

The requested scopes, split from the space-separated scope param.

Array<string>

prompt

string | null

Example ^generated

{
  "client_id": "example",
  "redirect_uri": "example",
  "response_type": "example",
  "scopes": [
    "example"
  ],
  "prompt": "example"
}

Responses

200

The app and scopes to show on the consent screen

Media type application/json

object

client

required

The app asking for access, as the consent screen shows it.

object

client_id

required

string

name

required

string

description

string | null

logo_url

string | null

client_type

string | null

consent_required

required

False when the member already approved this app for these scopes; the page can then continue without asking again.

boolean

scopes

required

Array<object>

One requested scope, and whether this member can grant it.

object

scope

required

string

description

string | null

is_grantable

required

boolean

Example ^generated

{
  "client": {
    "client_id": "example",
    "name": "example",
    "description": "example",
    "logo_url": "example",
    "client_type": "example"
  },
  "consent_required": true,
  "scopes": [
    {
      "scope": "example",
      "description": "example",
      "is_grantable": true
    }
  ]
}

400

The app, redirect or scopes were refused

401

Missing or invalid authentication

403

Not a dashboard session