Update token exchange settings

PUT

/api/admin/settings/token-exchange

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/settings/token-exchange \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "allowedSubjectTokenTypes": [ "access_token", "id_token" ], "maxResourceParams": 10, "maxAudienceParams": 10, "idJag": { "enabled": false, "allowedIssuers": [ "https://idp.example.com" ], "maxTokenLifetime": 300, "includeTenantClaim": true, "requireConfidentialClient": true } }'

Updates OAuth token exchange and optional ID-JAG settings in SETTINGS KV after validation.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

enabled

boolean

allowedSubjectTokenTypes

Array<string>

maxResourceParams

integer

>= 1 <= 100

maxAudienceParams

integer

>= 1 <= 100

idJag

object

enabled

boolean

allowedIssuers

Array<string>

maxTokenLifetime

integer

includeTenantClaim

boolean

requireConfidentialClient

boolean

key

additional properties

key

additional properties

Example

{
  "enabled": true,
  "allowedSubjectTokenTypes": [
    "access_token",
    "id_token"
  ],
  "maxResourceParams": 10,
  "maxAudienceParams": 10,
  "idJag": {
    "enabled": false,
    "allowedIssuers": [
      "https://idp.example.com"
    ],
    "maxTokenLifetime": 300,
    "includeTenantClaim": true,
    "requireConfidentialClient": true
  }
}

Responses

200

Token exchange settings updated.

Media type application/json

object

success

boolean

settings

object

key

additional properties

note

string

key

additional properties

Example

{
  "success": true,
  "settings": {
    "enabled": true,
    "allowedSubjectTokenTypes": [
      "access_token",
      "id_token"
    ],
    "maxResourceParams": 10,
    "maxAudienceParams": 10,
    "idJag": {
      "enabled": false,
      "allowedIssuers": [
        "https://idp.example.com"
      ],
      "maxTokenLifetime": 300,
      "includeTenantClaim": true,
      "requireConfidentialClient": true
    }
  },
  "note": "Settings updated successfully."
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}