describeOAuthApproval

GET

/api/v1/oauth/authorize

const url = 'https://example.com/api/v1/oauth/authorize?client_id=example&redirect_uri=https%3A%2F%2Fexample.com&scope=example&code_challenge=example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/oauth/authorize?client_id=example&redirect_uri=https%3A%2F%2Fexample.com&scope=example&code_challenge=example'

Requires an enrolled dashboard session. Describes one first-party authorization request (client, scopes, redirect) for the approval screen. Stores nothing; approval revalidates the same parameters.

Parameters

Query Parameters

client_id

required

string

redirect_uri

required

string format: uri

scope

required

string

state

string

code_challenge

required

string

code_challenge_method

string

S256, or omitted. The Server rejects any other value.

Responses

200

Approval description

application/json

object

data

required

object

client

required

object

name

required

string

clientId

required

string

scopes

required

Array<object>

object

scope

required

string

Allowed values: read write admin

description

required

string

redirectUri

required

string format: uri

state

required

string

Example

{
  "data": {
    "scopes": [
      {
        "scope": "read"
      }
    ]
  }
}

400

Unknown client, redirect, scope, or challenge

401

Dashboard authentication required