Skip to content

Retrieve the org request settings

Request

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

Retrieves the request settings for the org.

Org request settings indicate:

  • If the Access Requests app has been provisioned
  • If a customer has triggered Access Requests app provisioning in their org
  • The request experiences that are supported
  • If the provisioning for the Access Requests app was triggered a while ago
GET
/governance/api/v2/request-settings
curl -i -X GET \
  https://subdomain.okta.com/governance/api/v2/request-settings

Responses

A successful org 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
subprocessorsAcknowledgedboolean(subprocessors-acknowledged)required

Indicates that Access Requests provisioning was triggered by the customer (such as in Govern Okta admin roles)

provisioningStatusstring(provisioning-status)required

The Access Requests provisioning status in the org

Enum:"NOT_PROVISIONED""PROVISIONING_FAILED""PROVISIONED"
requestExperiencesArray of strings, >= 0 itemsrequired

The supported request experiences in the org

longTimePastProvisionedbooleanrequired

Indicates that Access Request provisioning was triggered more than 10 minutes ago

resourceCatalogVisibilityobject(resource-catalog-visibility)

Settings for resource catalog visibility

integrationsobject(request-integrations)


Access Requests integration settings for the org

Response
{ "subprocessorsAcknowledged": false, "provisioningStatus": "NOT_PROVISIONED", "requestExperiences": [], "longTimePastProvisioned": false }