Skip to content
Okta Identity Governance
/
/
/
Update the resource reque...

Update the resource request settings

Request

OAuth 2.0 scope:
  • okta.accessRequests.condition.manage
Admin roles:
  • ACCESS_REQUESTS_ADMIN

Updates the resource request settings

Path
resourceIdstringrequired

Unique identifier for the resource in Okta instance ID format or ORN format

Bodyapplication/jsonrequired
requestOnBehalfOfSettingsobject or null(request-on-behalf-of-settings-patchable)

Specifies if and for whom a requester may request the resource for.

riskSettingsobject(risk-settings-patchable)

Risk settings that are valid for an access request when a risk has been detected for the resource and requesting user

Request on behalf of settings where any requester can request

curl -i -X PATCH \
  'https://subdomain.okta.com/governance/api/v2/resources/{resourceId}/request-settings' \
  -H 'Content-Type: application/json' \
  -d '{
    "requestOnBehalfOfSettings": {
      "allowed": true
    }
  }'

Responses

A successful request settings patch response

Headers
X-Rate-Limit-Limitinteger, >= 1required

The rate-limit ceiling for the current request

Example:60
X-Rate-Limit-Remaininginteger, >= 0required

The number of requests left for the current rate-limit window

Example:60
X-Rate-Limit-Resetinteger, >= 0required

The time when the rate limit resets, specified in UTC epoch time (in seconds)

Example:1609459200
Bodyapplication/json
validAccessScopeSettingsArray of objects, [ 0 .. 3 ] items(valid-access-details)required

Access scope settings that are eligible to be added to a request condition for the specified resource

validRequesterSettingsArray of objects, [ 0 .. 3 ] items(valid-requester-settings-details)required

Request scope settings that are eligible to be added to a request condition for the specified resource

validAccessDurationSettingsobject(valid-access-duration-settings-details)required

Admin specified access duration settings added to a request condition or risk settings for the specified resource

requestOnBehalfOfSettingsobject(request-on-behalf-of-settings-details)

Specifies if and for whom a requester may request the resource for.

validRiskSettingsobject(valid-risk-settings-details)

Risk settings that are eligible for the specified resource

riskSettingsobject(risk-settings-details)

Risk settings that are valid for an access request when a risk has been detected for the resource and requesting user

validRequestOnBehalfOfSettingsArray of objects, [ 0 .. 2 ] items(valid-request-on-behalf-of-settings-details)

Request on behalf of settings that are eligible to be added to a request condition for the specified resource

Response

When resource:

  • Has entitlement management enabled
  • Has at least one entitlement value
  • Has at least one entitlement bundle
{
  "validAccessScopeSettings": [
    { … },
    { … }
  ],
  "validRequesterSettings": [
    { … },
    { … }
  ],
  "validAccessDurationSettings": {
    "required": true,
    "maximumDays": 365,
    "maximumHours": 72,
    "maximumWeeks": 52,
    "supportedTypes": [ … ]
  },
  "validRiskSettings": {
    "supportedTypes": []
  },
  "validRequestOnBehalfOfSettings": [
    { … },
    { … }
  ]
}