Update Access Request Configuration

PUT 
/access-request-config

This endpoint replaces the current access-request configuration. A token with ORG_ADMIN authority is required to call this API.

Request

application/json

Body

required

approvalsMustBeExternal boolean

If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin.

autoApprovalEnabled boolean

If this is true and the requester and reviewer are the same, the request is automatically approved.

requestOnBehalfOfConfig

object

Request On Behalf Of configuration.

allowRequestOnBehalfOfAnyoneByAnyone boolean

If this is true, anyone can request access for anyone.

allowRequestOnBehalfOfEmployeeByManager boolean

If this is true, a manager can request access for his or her direct reports.

approvalReminderAndEscalationConfig

object

Approval reminder and escalation configuration.

daysUntilEscalation int32nullable

Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.

daysBetweenReminders int32nullable

Number of days to wait between reminder notifications.

maxReminders int32nullable

Possible values: >= 1

Maximum number of reminder notification to send to the reviewer before approval escalation.

fallbackApproverRef

object

nullable

type string

The type can only be IDENTITY. This is read-only.

id string

Identity ID.

name string

Identity's human-readable display name. This is read-only.

email string

Identity's email address. This is read-only.

entitlementRequestConfig

object

Entitlement request configuration.

allowEntitlementRequest boolean

If this is true, entitlement requests are allowed.

requestCommentsRequired boolean

If this is true, comments are required to submit entitlement requests.

deniedCommentsRequired boolean

If this is true, comments are required to reject entitlement requests.

grantRequestApprovalSchemes stringnullable

Default value: sourceOwner

Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are "entitlementOwner", "sourceOwner", "manager" and "workgroup:{id}". You can use multiple governance groups (workgroups).

Responses

200

Access Request Configuration Details.

application/json

Schema

Schema

approvalsMustBeExternal boolean

If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin.

autoApprovalEnabled boolean

If this is true and the requester and reviewer are the same, the request is automatically approved.

requestOnBehalfOfConfig

object

Request On Behalf Of configuration.

allowRequestOnBehalfOfAnyoneByAnyone boolean

If this is true, anyone can request access for anyone.

allowRequestOnBehalfOfEmployeeByManager boolean

If this is true, a manager can request access for his or her direct reports.

approvalReminderAndEscalationConfig

object

Approval reminder and escalation configuration.

daysUntilEscalation int32nullable

Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.

daysBetweenReminders int32nullable

Number of days to wait between reminder notifications.

maxReminders int32nullable

Possible values: >= 1

Maximum number of reminder notification to send to the reviewer before approval escalation.

fallbackApproverRef

object

nullable

type string

The type can only be IDENTITY. This is read-only.

id string

Identity ID.

name string

Identity's human-readable display name. This is read-only.

email string

Identity's email address. This is read-only.

entitlementRequestConfig

object

Entitlement request configuration.

allowEntitlementRequest boolean

If this is true, entitlement requests are allowed.

requestCommentsRequired boolean

If this is true, comments are required to submit entitlement requests.

deniedCommentsRequired boolean

If this is true, comments are required to reject entitlement requests.

grantRequestApprovalSchemes stringnullable

Default value: sourceOwner

Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are "entitlementOwner", "sourceOwner", "manager" and "workgroup:{id}". You can use multiple governance groups (workgroups).

Example (from schema)

{
  "approvalsMustBeExternal": true,
  "autoApprovalEnabled": true,
  "requestOnBehalfOfConfig": {
    "allowRequestOnBehalfOfAnyoneByAnyone": true,
    "allowRequestOnBehalfOfEmployeeByManager": true
  },
  "approvalReminderAndEscalationConfig": {
    "daysUntilEscalation": 0,
    "daysBetweenReminders": 0,
    "maxReminders": 1,
    "fallbackApproverRef": {
      "type": "IDENTITY",
      "id": "5168015d32f890ca15812c9180835d2e",
      "name": "Alison Ferguso",
      "email": "[email protected]"
    }
  },
  "entitlementRequestConfig": {
    "allowEntitlementRequest": true,
    "requestCommentsRequired": false,
    "deniedCommentsRequired": false,
    "grantRequestApprovalSchemes": "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"
  }
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...