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.

Retrieve the request settings for a resource
Beta
Admin permissions required: Access Requests Administrator
OAuth 2.0: okta.accessRequests.condition.read

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.
  • requestOnBehalfOfSettings if they exist, they indicate the settings specified for request on behalf of.

See response examples for various possible request setting scenarios.

Request
path Parameters
resourceId
required
string

The id of the resouce in okta id format or ORN format

Responses
200

A successful request settings get response

401

When authentication fails

403

When authorization fails

404

When the requested resource was not found

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/{resourceId}/request-settings
Request samples 
Response samples 
application/json
When resource:


    

  • Has governance engine enabled
    • 

  • Has at least one entitlement value
    • 

  • Has at least one entitlement bundle
    • 



{
  • "validAccessScopeSettings": [
    • {
      • "type": "RESOURCE_DEFAULT"
      },
    • {
      • "type": "ENTITLEMENT_BUNDLES"
      }
    ],
  • "validRequesterSettings": [
    • {
      • "type": "EVERYONE"
      },
    • {
      • "type": "GROUPS"
      }
    ],
  • "validAccessDurationSettings": {
    • "required": true,
    • "maximumDays": 90,
    • "maximumHours": 72,
    • "maximumWeeks": 12,
    • "supportedTypes": [
      • {
        }
      ]
    }
}
Update the resource request settings
Beta
Admin permissions required: Access Requests Administrator
OAuth 2.0: okta.accessRequests.condition.manage
Updates the resource request settings


Request 
path Parameters
resourceId
required
string
The id of the resouce in okta id format or ORN format


 
Request Body schema: application/json
required
object or null
Specifies if and for whom a requester may request the resource for.


 
Responses 
200
A successful request settings patch response


401
When authentication fails


403
When authorization fails


404
When the requested resource was not found


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/{resourceId}/request-settings
Request samples 
application/json
Request on behalf of settings where any requester can request


{
  • "requestOnBehalfOfSettings": {
    • "allowed": true
    }
}
Response samples 
application/json
When resource:


    

  • Has governance engine enabled
    • 

  • Has at least one entitlement value
    • 

  • Has at least one entitlement bundle
    • 



{
  • "validAccessScopeSettings": [
    • {
      • "type": "RESOURCE_DEFAULT"
      },
    • {
      • "type": "ENTITLEMENT_BUNDLES"
      }
    ],
  • "validRequesterSettings": [
    • {
      • "type": "EVERYONE"
      },
    • {
      • "type": "GROUPS"
      }
    ],
  • "validAccessDurationSettings": {
    • "required": true,
    • "maximumDays": 90,
    • "maximumHours": 72,
    • "maximumWeeks": 12,
    • "supportedTypes": [
      • {
        }
      ]
    }
}
Retrieve the request settings for the organization
Beta
Admin permissions required: Access Requests Administrator
OAuth 2.0: okta.accessRequests.condition.read
Retrieves the request settings for the org


The org settings currently encapsulates:


    

  • Whether a customer has acknowledged Access Requests sub-processors
    • 

  • Whether Access Requests org has been provisioned
    • 

  • Which request experiences are supported
    • 

  • Whether it has been a long time since the Access Requests org has been provisioned
    • 



Responses 
200
A successful org request settings get response


401
When authentication fails


403
When authorization fails


404
When the requested resource was not found


429
When the rate limit has been exceeded


500
When there is a server fault due to an unexpected error


get/governance/api/v2/request-settings
Request samples 
Response samples 
application/json
{
  • "subprocessorsAcknowledged": false,
  • "provisioningStatus": "NOT_PROVISIONED",
  • "requestExperiences": [ ],
  • "longTimePastProvisioned": false
}
Update the request settings for the organization
Beta
Admin permissions required: Access Requests Administrator
OAuth 2.0: okta.accessRequests.condition.manage
Updates the request settings for the org


Request 
Request Body schema: application/json
required
subprocessorsAcknowledged
required
boolean
Whether a customer has acknowledged Access Requests subprocessors


 
Responses 
200
A successful org request settings patch response


401
When authentication fails


403
When authorization fails


404
When the requested resource was not found


429
When the rate limit has been exceeded


500
When there is a server fault due to an unexpected error


patch/governance/api/v2/request-settings
Request samples 
application/json
Request Settings for the org for patch example


{
  • "subprocessorsAcknowledged": true
}
Response samples 
application/json
Request Settings for the org for patch example


{
  • "subprocessorsAcknowledged": true
}