Entitlement Settings

Update the entitlement settings for the resource
Beta
OAuth 2.0 scopes:
  • okta.governance.entitlements.manage
Admin roles:
  • APP_ADMIN

Updates entitlement settings for a resource

Request
path Parameters
resourceOrn
required
string

The resource ORN

Request Body schema: application/json
required

The updatable attributes of the entitlement settings

status
required
string

Specify to opt in (enable) or opt out of (disable) entitlement management for the resource

Enum: "OPTED_IN" "OPTED_OUT"
Responses
202

A successful entitlement settings update operation

400

An invalid request to update the entitlement settings

401

When authentication fails

403

When authorization fails

429

When the rate limit has been exceeded

500

When there is a server fault due to an unexpected error

patch/governance/api/v2/resources/{resourceOrn}/entitlement-settings
Request samples
application/json

Updates entitlement settings to opt in the resource to entitlement management feature

{
  • "status": "OPTED_IN"
}
Response samples
application/json
{
  • "status": "OPTING_IN"
}

Retrieve the entitlement settings for the resource
Beta
OAuth 2.0 scopes:
  • okta.governance.entitlements.read
Admin roles:
  • APP_ADMIN

Retrieves entitlement settings for the resource

Request
path Parameters
resourceOrn
required
string

The resource ORN

Responses
200

A successful entitlement settings update operation

400

An invalid request to update the entitlement settings

401

When authentication fails

403

When authorization fails

429

When the rate limit has been exceeded

500

When there is a server fault due to an unexpected error

get/governance/api/v2/resources/{resourceOrn}/entitlement-settings
Request samples
Response samples
application/json
{
  • "status": "OPTING_IN"
}