Accept OAuth2 Consent Request

PUT/appid-{appId}/recipe/oauth/auth/requests/consent/accept

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.

Request body

application/json

contextobject

grantAccessTokenAudiencestring[]

grantScopestring[]

handledAtstring<date-time>

rememberboolean

rememberForinteger

sessionobject

Show properties

accessTokenobject

idTokenobject

Responses

200OAuth2 Consent Request Result

One of:

object

statusstatusOK

Allowed:OK

redirectTostring

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*

Bodyapplication/json

Request body

Request

curl -X PUT "/appid-{appId}/recipe/oauth/auth/requests/consent/accept?consentChallenge=1234567890" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "context": {},
  "grantAccessTokenAudience": [
    "string"
  ],
  "grantScope": [
    "string"
  ],
  "handledAt": "2019-08-24T14:15:22Z",
  "remember": true,
  "rememberFor": 0,
  "session": {
    "accessToken": {},
    "idToken": {}
  }
}'

const response = await fetch("/appid-{appId}/recipe/oauth/auth/requests/consent/accept?consentChallenge=1234567890", {
  method: "PUT",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "context": {},
  "grantAccessTokenAudience": [
    "string"
  ],
  "grantScope": [
    "string"
  ],
  "handledAt": "2019-08-24T14:15:22Z",
  "remember": true,
  "rememberFor": 0,
  "session": {
    "accessToken": {},
    "idToken": {}
  }
})
});

import requests

response = requests.put(
    "/appid-{appId}/recipe/oauth/auth/requests/consent/accept?consentChallenge=1234567890",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "context": {},
  "grantAccessTokenAudience": [
    "string"
  ],
  "grantScope": [
    "string"
  ],
  "handledAt": "2019-08-24T14:15:22Z",
  "remember": True,
  "rememberFor": 0,
  "session": {
    "accessToken": {},
    "idToken": {}
  }
},
)

Response

{
  "status": "OK",
  "redirectTo": "{apiDomain}/oauth/consent?..."
}

"string"

"Invalid API key"

"License Error"

"Not Found"

"Internal Error"