Get OAuth2 Consent Request

GET/appid-{appId}/recipe/oauth/auth/requests/consent

Authorization

api-keyAPI key · headerrequired

The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.

Query parameters

consentChallengestringrequired

Header parameters

cdi-versionstring

X.Y of the X.Y.Z CDI version.

Responses

200OAuth2 Consent Request Result

One of:

object

statusstatusOK

Allowed:OK

clientoauthClient

Show properties

clientIdstring

clientNamestring

clientSecretstring

redirectUrisstring[]

grantTypesstring[]

responseTypesstring[]

scopestring

audiencestring[]

policyUristring

allowedCorsOriginsstring[]

tosUristring

clientUristring

logoUristring

tokenEndpointAuthMethodstring

createdAtstring<date-time>

updatedAtstring<date-time>

postLogoutRedirectUrisstring[]

metadataobject

authorizationCodeGrantAccessTokenLifespanstring | null

authorizationCodeGrantIdTokenLifespanstring | null

authorizationCodeGrantRefreshTokenLifespanstring | null

clientCredentialsGrantAccessTokenLifespanstring | null

implicitGrantAccessTokenLifespanstring | null

implicitGrantIdTokenLifespanstring | null

refreshTokenGrantIdTokenLifespanstring | null

refreshTokenGrantAccessTokenLifespanstring | null

refreshTokenGrantRefreshTokenLifespanstring | null

enableRefreshTokenRotationboolean

requestedScopestring[]

requestedAudiencestring[]

requestedClaimsobject

Show properties

idTokenobject

Show properties

property1string

property2string

loginHintstring

uiLocalesstring[]

acrValuesstring[]

subjectstring

requestUrlstring

skipboolean

clientIdstring

redirectUristring

forceSubjectIdentifierstring

requestedAccessTokenAudiencestring[]

contextobject

sessionIdstring

loginSessionIdstring

loginChallengestring

loginRequestedAtstring

consentRequestedAtstring

consentChallengestring

consentSkipboolean

consentRememberboolean

consentRememberForinteger

consentErrorobject

Show properties

namestring

descriptionstring

consentErrorDebugstring

consentErrorDescriptionstring

consentErrorHintstring

consentErrorCodestring

consentStatusCodeinteger

sessionIdTokenobject

Show properties

property1string

property2string

sessionAccessTokenobject

Show properties

property1string

property2string

sessionTokenobject

Show properties

property1string

property2string

oauthError

statusstringrequired

Allowed:OAUTH_ERROR

errorstringrequired

errorDescriptionstringrequired

statusCodeintegerrequired

400error code 400

string

401error code 401

string

402error code 402

string

404error code 404

string

500error code 500

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

cdi-versionheaderX.Y of the X.Y.Z CDI version.consentChallengequery*

Request

curl -X GET "/appid-{appId}/recipe/oauth/auth/requests/consent?consentChallenge=1234567890" \
  -H "api-key: YOUR_API_KEY"

const response = await fetch("/appid-{appId}/recipe/oauth/auth/requests/consent?consentChallenge=1234567890", {
  method: "GET",
  headers: {
    "api-key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "/appid-{appId}/recipe/oauth/auth/requests/consent?consentChallenge=1234567890",
    headers={
        "api-key": "YOUR_API_KEY"
    },
)

Response

{
  "status": "OK",
  "client": {
    "clientId": "stcl_c6dd9189-33b8-4ec0-8aea-a0ffdaf75fcb",
    "clientName": "Hello",
    "clientSecret": "T98n1YIMWqr4wOM.~bV4HOPFmO",
    "redirectUris": [
      "http://localhost:3000/auth/callback/ory"
    ],
    "grantTypes": [
      "authorization_code",
      "refresh_token"
    ],
    "responseTypes": [
      "code",
      "id_token"
    ],
    "scope": "offline_access openid email",
    "audience": [],
    "policyUri": "",
    "allowedCorsOrigins": [],
    "tosUri": "",
    "clientUri": "",
    "logoUri": "",
    "tokenEndpointAuthMethod": "client_secret_post",
    "createdAt": "2025-02-24T08:14:40Z",
    "updatedAt": "2025-02-24T08:14:40.362463Z",
    "postLogoutRedirectUris": [
      "http://localhost:3000"
    ],
    "metadata": {},
    "authorizationCodeGrantAccessTokenLifespan": "1h0m0s",
    "authorizationCodeGrantIdTokenLifespan": "1h0m0s",
    "authorizationCodeGrantRefreshTokenLifespan": "1h0m0s",
    "clientCredentialsGrantAccessTokenLifespan": "1h0m0s",
    "implicitGrantAccessTokenLifespan": "1h0m0s",
    "implicitGrantIdTokenLifespan": "1h0m0s",
    "refreshTokenGrantIdTokenLifespan": "1h0m0s",
    "refreshTokenGrantAccessTokenLifespan": "1h0m0s",
    "refreshTokenGrantRefreshTokenLifespan": "1h0m0s",
    "enableRefreshTokenRotation": false
  },
  "requestedScope": [
    "string"
  ],
  "requestedAudience": [
    "string"
  ],
  "requestedClaims": {
    "idToken": {
      "property1": "string",
      "property2": "string"
    }
  },
  "loginHint": "string",
  "uiLocales": [
    "string"
  ],
  "acrValues": [
    "string"
  ],
  "subject": "string",
  "requestUrl": "string",
  "skip": true,
  "clientId": "string",
  "redirectUri": "string",
  "forceSubjectIdentifier": "string",
  "requestedAccessTokenAudience": [
    "string"
  ],
  "context": {},
  "sessionId": "string",
  "loginSessionId": "string",
  "loginChallenge": "string",
  "loginRequestedAt": "string",
  "consentRequestedAt": "string",
  "consentChallenge": "string",
  "consentSkip": true,
  "consentRemember": true,
  "consentRememberFor": 0,
  "consentError": {
    "name": "string",
    "description": "string"
  },
  "consentErrorDebug": "string",
  "consentErrorDescription": "string",
  "consentErrorHint": "string",
  "consentErrorCode": "string",
  "consentStatusCode": 0,
  "sessionIdToken": {
    "property1": "string",
    "property2": "string"
  },
  "sessionAccessToken": {
    "property1": "string",
    "property2": "string"
  },
  "sessionToken": {
    "property1": "string",
    "property2": "string"
  }
}

"string"

"Invalid API key"

"License Error"

"Not Found"

"Internal Error"