Edit a setup

PUT /v2/modules/:module/setups/:setupId

Updates the configuration of an existing OAuth setup. The full setup definition must be provided; partial updates are not supported. Changes can be scheduled for a future effective date by setting a validFrom timestamp in the request body, which creates a new snapshot rather than immediately replacing the active configuration. Only admin users may perform this operation.

Request

Path Parameters

module stringrequired

setupId stringrequired

application/json

Body

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

Responses

Setups edited successfully

application/json

Schema
Example (from schema)

Schema