Skip to content
Authrim

Return consent request state for a consent challenge.

GET
/api/auth/consents
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/auth/consents

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
challenge_id
required
string
client
required
object
client_id
string
client_name
string
logo_uri
string
client_uri
string
policy_uri
string
tos_uri
string
is_trusted
boolean
scopes
required
Array<object>
object
key
additional properties
user
required
object
key
additional properties
organizations
Array<object>
object
key
additional properties
primary_org
Any of:
object
key
additional properties
roles
Array<object>
object
key
additional properties
features
object
key
additional properties
granular_scopes_enabled
boolean
consent_management_enabled
boolean
consent_language
string
Example 
{
  "challenge_id": "consent_123",
  "client": {
    "client_id": "client_123",
    "client_name": "Example App",
    "is_trusted": false
  },
  "scopes": [
    {
      "scope": "openid",
      "required": true
    }
  ],
  "user": {
    "id": "user_123"
  },
  "organizations": [],
  "primary_org": null,
  "roles": [],
  "features": {
    "org_selector_enabled": false
  },
  "granular_scopes_enabled": false,
  "consent_management_enabled": false,
  "consent_language": "en"
}