Skip to content
Okta Identity Governance
/
Management APIs
/
/Request Settings

Request Settings

Request settings are useful for managing your org's access requests.

Request settings can be read and updated at the org and resource level.

The information provided by request settings may be used to determine if another operation, such as creating a request condition, is valid for a particular organization and resource.

See Access requests - Get started for information on setting up access requests for your organization.

Operations

Retrieve the resource request settings

Request

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

Retrieves the request settings for a resource

Resource request settings are useful for determining what kind of request conditions can be created or updated for a resource.

For example:

  • validAccessScopeSettings indicates what accessScopeSettings may be passed in a Create request condition or Update request condition operation.
  • validRequesterSettings indicates what requesterSettings may be passed in a Create request condition or Update request condition operation.
  • validAccessDurationSettings indicates the maximum duration the user will have access to the resources.
  • validRiskSettings indicates what riskSettings may be passed. Currently, it can be at the resource request settings.
  • validRequestOnBehalfOfSettings indicates the available request on behalf of settings for the resource.
  • requestOnBehalfOfSettings if they exist, they indicate the settings specified for request on behalf of.
  • riskSettings if they exist, they indicate the risk settings specified for the resource.

See response examples for various possible request setting scenarios.

Path
resourceIdstringrequired

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

GET
/governance/api/v2/resources/{resourceId}/request-settings
curl -i -X GET \
  'https://okta-subdomain.pixtulate.com/governance/api/v2/resources/{resourceId}/request-settings'

Responses

A successful request settings get 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": [
    { … },
    { … }
  ]
}