Return a setup

GET 
/v2/modules/:module/setups/:setupId

Retrieves the full configuration of a specific OAuth setup identified by its ID. Returns all properties including token lifetimes, grant type settings, and associated resource server references.

Request

Path Parameters

module stringrequired
setupId stringrequired

Responses

200

Setups retrieved successfully

application/json

Schema

Schema

client_defaults objectrequired
grant_types string[]required
force_reauthentication boolean
access_token_ttl integer
refresh_token_ttl integer
id_token_ttl integer
persisted_consent_ttl integer
resource_server_defaults objectrequired
scope_policy_implicit_flow string
scope_policy_authorization_code_flow string
scope_policy_refresh_token string
scope_policy_force_reauthentication boolean
metadata object[]required
Array [
name string
value string
locale string
]
name stringrequired
owner stringrequired
comment string
valid_from date-timerequired

Example (from schema)

{
  "client_defaults": {
    "grant_types": [
      "string"
    ],
    "force_reauthentication": true,
    "access_token_ttl": 0,
    "refresh_token_ttl": 0,
    "id_token_ttl": 0,
    "persisted_consent_ttl": 0
  },
  "resource_server_defaults": {
    "scope_policy_implicit_flow": "string",
    "scope_policy_authorization_code_flow": "string",
    "scope_policy_refresh_token": "string",
    "scope_policy_force_reauthentication": true
  },
  "metadata": [
    {
      "name": "string",
      "value": "string",
      "locale": "string"
    }
  ],
  "name": "string",
  "owner": "string",
  "comment": "string",
  "valid_from": "2024-07-29T15:51:28.071Z"
}

404

No setup exists with the specified ID

Loading...