Skip to content
Okta Identity Governance
/
/
/
Update a request

Update a request

Request

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

Updates a request with the specified requestId

Path
requestIdstring, (rcar-request-id), = 20 characters(rcar-request-id)req[0-9a-zA-Z]+required

Unique identifier for the Resource-Centric Access Requests (RCAR) request

Example:reqp1pmpjhVdGEcVK1d5
Bodyapplication/jsonrequired
statusstring(request-status-patchable)

Specify the status of the request

ValueDescription
CANCELED

Only CANCELED is supported. You can't cancel a request if any of its tasks have been resolved.

Example:"CANCELED"
curl -i -X PATCH \
  https://subdomain-okta.login.adsbillinghub.com/governance/api/v2/requests/reqp1pmpjhVdGEcVK1d5 \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "CANCELED"
  }'

Responses

A successful update request 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
idstring, non-emptyrequired

Unique identifier for the object

createdBystring, (okta-user-id), [ 1 .. 20 ] characters(created-by)read-onlyrequired

The id of the Okta user who created the resource

createdstring, (date-time)(created)read-onlyrequired

The ISO 8601 formatted date and time when the resource was created

lastUpdatedstring, (date-time)(last-updated)read-onlyrequired

The ISO 8601 formatted date and time when the object was last updated

lastUpdatedBystring, (okta-user-id), [ 1 .. 20 ] characters(last-updated-by)read-onlyrequired

The id of the Okta user who last updated the object

statusstring(request-status)required

The status of the request

Enum:"SUBMITTED""REJECTED""PENDING""APPROVED""DENIED""CANCELED""EXPIRED"
resolvedstring or null, (date-time)(request-resolved-date-time)

The date the request was resolved. The property may transition from having a value to null if the request is reopened.

grantStatusstring(request-grant-status)

The grant status of the request

Enum:"PENDING""GRANTED""FAILED""MANUAL_REQUIRED"
grantedstring or null, (date-time)(request-granted-date-time)

The date the approved access was granted. Only set if request.status is APPROVED.

revocationStatusstring(request-revocation-status)

The revocation status of the request

Enum:"PENDING""REVOKED""FAILED"
revokedstring or null, (date-time)(request-revoked-date-time)

The date the granted access was revoked. Only set if request.grantStatus is GRANTED and request.revocationStatus is REVOKED.

requestedByobject(client-credential-principal)required

A representation of a principal

requestedForobject(target-principal)required

A representation of a principal

requestedobject(requested)required

A representation of the resource in request

accessDurationstring or null, (iso-duration)(request-duration)

How long the requester retains access after their request is approved and fulfilled.

Specified in ISO 8601 duration format.

Known limitation

Only single time unit ISO 8601 duration formats (D, H, M) are supported for units (days, hours, minutes).

Supported
UnitExample
D, daysP40D
H, hoursPT65H
M, minutesPT90M

Note: Mixes of units, as well as month/year/week designations, aren't supported. For example, P40DT65H, P40M, P1W, and P1Y aren't supported.

Default:null
Example:"P40D"
revocationScheduledstring or null, (date-time)(request-revocation-scheduled-date-time)

The date the granted access is scheduled for recovation. Only set if request.accessDuration exists, and request.grantStatus is GRANTED.

requesterFieldValuesArray of objects(request-field-values)

The requester input fields required by the approval system.

Note: The fields required are determined by the approval system.

For the Okta approval system, the required fields are defined in the approval sequence. Ensure that the requester input fields match up with this definition to avoid request approval flow failure.

For external approval systems, the requester input fields are for recording purposes only and do not affect the approval process.

requestApprovalobject(request-approval)

A completed access request approval

riskAssessmentobject(risk-assessment)

A risk assessment that indicates whether request submission is allowed or restricted. It contains the risk rules that lead to possible conflicts for the requested resource.

Response

No further actions can be taken on a CANCELED request.

{
  "id": "req42kjDgk1EubTwo0g4",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "00ub0oNGTSWTBKOLGLNR",
  "lastUpdated": "2022-05-05T14:15:22Z",
  "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR",
  "status": "CANCELED",
  "requestedBy": {
    "type": "OKTA_USER",
    "externalId": "00ub0oNGTSWTBKOLGLNR"
  },
  "requestedFor": {
    "type": "OKTA_USER",
    "externalId": "00ub0oNGTSWTBKOLGLNR"
  },
  "requesterFieldValues": [
    { … }
  ],
  "requested": {
    "entryId": "cenb0oADRXTBKOLGLNR",
    "resourceId": "0oafxqCAJWWGELFTYASJ",
    "resourceType": "APPLICATION",
    "accessScopeId": "0oafxqCAJWWGELFTYASJ",
    "accessScopeType": "APPLICATION"
  },
  "_links": {
    "catalogEntry": { … },
    "self": { … }
  }
}