Skip to content
adversarial

Get the details to show on the consent screen

GET
/v1/oauth/consent-info
curl --request GET \
  --url https://api.adversarial.com/api/v1/oauth/consent-info \
  --cookie arm-session=<arm-session>

Returns the name of the client requesting access, the organizations the grant can be bound to, and the scopes that can be granted in each, so the consent screen can describe both what is being granted and where. Requires a pending authorization request in the current session.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Consent screen metadata

Media typeapplication/json

Everything needed to render a consent screen: who is asking for access and what they are asking for.

object
client_id
required
string
client_name
required
string
is_dynamic
required
boolean
organizations
required

Organizations this grant may bind to, in resume order (last-used first). Never empty — an empty set is an error, not a response.

Array<object>

One selectable organization on the consent screen, with the scopes this user can actually grant inside it.

object
display_name
required
string
icon
string | null
id
required
string format: uuid
is_session_org
required

True for the organization the browser session currently points at. Has no effect on the grant.

boolean
scopes
required

Requested scopes this user can grant in this organization. May be empty — a member with no matching permissions still sees their org listed rather than silently missing.

Array<object>
object
description
required

Human-readable description of what this scope grants, suitable for showing to the person approving it.

string
scope
required

Machine-readable scope label, e.g. “risks:read”.

string
slug
required
string
redirect_uri
required
string
requested_scopes
required

Everything the client asked for, before any per-organization intersection. Empty when the client omitted scope entirely.

Array<string>
resource
string | null
selected_org_id
required

The organization pre-selected on the screen: the session org when it is grantable, otherwise the first entry of organizations.

string format: uuid
Examplegenerated
{
  "client_id": "example",
  "client_name": "example",
  "is_dynamic": true,
  "organizations": [
    {
      "display_name": "example",
      "icon": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "is_session_org": true,
      "scopes": [
        {
          "description": "example",
          "scope": "example"
        }
      ],
      "slug": "example"
    }
  ],
  "redirect_uri": "example",
  "requested_scopes": [
    "example"
  ],
  "resource": "example",
  "selected_org_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

400

Section titled “400”

No pending authorize request

401

Section titled “401”

Not authenticated

403

Section titled “403”

No organization this client may be authorized for

404

Section titled “404”

Referenced client no longer exists