OAuth consent context

GET

/oauth/consent/context

const url = 'https://example.com/api/oauth/consent/context?authorization_id=example';
const options = {method: 'GET', headers: {cookie: 'sb-access-token=<sb-access-token>'}};

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/oauth/consent/context?authorization_id=example' \
  --cookie sb-access-token=<sb-access-token>

Facts the consent screen needs before a human decides: client label, redirect target, requested scopes, and whether the client is first-party — true only when every redirect URI the client registered is a trusted CUSTOM-SCHEME native-app callback (the only case the portal may auto-approve). Vendor-hosted https callbacks are never first-party: they relay the code into whichever vendor session began the flow. Requires a first-party portal session JWT in the Authorization header (a delegated OAuth access token is refused with 401); read-only. Unknown or expired authorizations return a generic 404 so the endpoint cannot be used to enumerate authorization ids.

Authorizations

cookieAuth

Parameters

Query Parameters

authorization_id

required

string

>= 1 characters <= 255 characters

Responses

200

Consent context

application/json

object

client_name

required

string | null

redirect_uri

required

string | null

scopes

required

Array<string>

first_party

required

boolean

400

Invalid request

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

401

Not authenticated

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

reconnect

True if re-linking GitHub may fix the issue

boolean

404

Not found

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

429

Rate limited

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

retryAfter

Seconds until the rate limit resets

number

Headers

Retry-After

string