Edit a resource server

PUT 
/v2/modules/:module/setups/:setupId/resource-servers/:resourceId

Updates the configuration of an existing resource server, including its declared scopes. The full resource server definition must be provided. Changes can be scheduled to take effect at a future date by supplying a validFrom timestamp in the request body, which creates a new snapshot.

Request

Path Parameters

module stringrequired
setupId stringrequired
resourceId stringrequired

Query Parameters

replaceActiveState boolean

application/json

Body

scopes object[]required
Array [
metadata object[]
Array [
name string
value string
locale string
]
name string
policy_implicit_flow string
policy_authorization_code_flow string
policy_refresh_token string
policy_force_reauthentication boolean
custom_claims string
]
metadata object[]
Array [
name string
value string
locale string
]
name string
owner string
comment string
uri uri
valid_from date-time

Responses

200

Resource server successfully edited

application/json

Schema

Schema

scopes object[]required
Array [
metadata object[]
Array [
name string
value string
locale string
]
name string
policy_implicit_flow string
policy_authorization_code_flow string
policy_refresh_token string
policy_force_reauthentication boolean
custom_claims string
]
metadata object[]
Array [
name string
value string
locale string
]
name string
owner string
comment string
uri uri
valid_from date-time

Example (from schema)

{
  "scopes": [
    {
      "metadata": [
        {
          "name": "string",
          "value": "string",
          "locale": "string"
        }
      ],
      "name": "string",
      "policy_implicit_flow": "string",
      "policy_authorization_code_flow": "string",
      "policy_refresh_token": "string",
      "policy_force_reauthentication": true,
      "custom_claims": "string"
    }
  ],
  "metadata": [
    {
      "name": "string",
      "value": "string",
      "locale": "string"
    }
  ],
  "name": "string",
  "owner": "string",
  "comment": "string",
  "uri": "string",
  "valid_from": "2024-07-29T15:51:28.071Z"
}

400

The request body contains invalid or missing resource server properties

403

The caller does not have administrator privileges required to edit this resource server

404

No resource server exists with the specified ID in this setup

Loading...