--- id: list-access-request-status sidebar_label: Access Request Status hide_title: true hide_table_of_contents: true api: {"operationId":"listAccessRequestStatus","tags":["Access Requests"],"description":"The Access Request Status API returns a list of access request statuses based on the specified query parameters.\nAny token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users.","parameters":[{"in":"query","name":"requested-for","schema":{"type":"string"},"example":"2c9180877b2b6ea4017b2c545f971429","description":"Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false},{"in":"query","name":"requested-by","schema":{"type":"string"},"example":"2c9180877b2b6ea4017b2c545f971429","description":"Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","required":false},{"in":"query","name":"regarding-identity","schema":{"type":"string"},"example":"2c9180877b2b6ea4017b2c545f971429","description":"Filter the results by the specified identity which is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.","required":false},{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.","required":false,"schema":{"type":"boolean","default":false},"example":false},{"in":"query","name":"limit","description":"Max number of results to return.","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250},"example":100},{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.","required":false,"schema":{"type":"integer","format":"int32","minimum":0},"example":10}],"responses":{"200":{"description":"List of requested item status.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Human-readable display name of the item being requested.","example":"AccessProfile1"},"type":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"Type of requested object.","example":"ACCESS_PROFILE"},"cancelledRequestDetails":{"type":"object","properties":{"comment":{"type":"string","description":"Comment made by the owner when cancelling the associated request.","example":"Nisl quis ipsum quam quisque condimentum nunc ut dolor nunc."},"owner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}},"modified":{"type":"string","format":"date-time","description":"Date comment was added by the owner when cancelling the associated request","example":"2019-12-20T09:17:12.192Z"}},"description":"Provides additional details for a request that has been cancelled."},"errorMessages":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"description":"List of list of localized error messages, if any, encountered during the approval/provisioning process."},"state":{"type":"string","enum":["EXECUTING","REQUEST_COMPLETED","CANCELLED","TERMINATED","PROVISIONING_VERIFICATION_PENDING","REJECTED","PROVISIONING_FAILED","NOT_ALL_ITEMS_PROVISIONED","ERROR"],"description":"Indicates the state of an access request:\n* EXECUTING: The request is executing, which indicates the system is doing some processing.\n* REQUEST_COMPLETED: Indicates the request has been completed.\n* CANCELLED: The request was cancelled with no user input.\n* TERMINATED: The request has been terminated before it was able to complete.\n* PROVISIONING_VERIFICATION_PENDING: The request has finished any approval steps and provisioning is waiting to be verified.\n* REJECTED: The request was rejected.\n* PROVISIONING_FAILED: The request has failed to complete.\n* NOT_ALL_ITEMS_PROVISIONED: One or more of the requested items failed to complete, but there were one or more successes.\n* ERROR: An error occurred during request processing.","example":"EXECUTING"},"approvalDetails":{"type":"array","items":{"type":"object","properties":{"forwarded":{"type":"boolean","description":"True if the request for this item was forwarded from one owner to another."},"originalOwner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Base identity/workgroup reference object representing the original owner, if forwarded."},"currentOwner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Base reference of approver that will make decision."},"reviewedBy":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity who has reviewed the approval."},"modified":{"type":"string","format":"date-time","description":"Time at which item was modified.","example":"2019-08-23T18:52:57.398Z"},"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED","EXPIRED","CANCELLED","ARCHIVED"],"description":"Indicates the state of the request processing for this item:\n* PENDING: The request for this item is awaiting processing.\n* APPROVED: The request for this item has been approved.\n* REJECTED: The request for this item was rejected.\n* EXPIRED: The request for this item expired with no action taken.\n* CANCELLED: The request for this item was cancelled with no user action.\n* ARCHIVED: The request for this item has been archived after completion.","example":"PENDING"},"scheme":{"type":"string","enum":["APP_OWNER","SOURCE_OWNER","MANAGER","ROLE_OWNER","ACCESS_PROFILE_OWNER","GOVERNANCE_GROUP"],"description":"Describes the individual or group that is responsible for an approval step."},"errorMessages":{"type":"array","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}},"description":"If the request failed, includes any error messages that were generated."},"comment":{"type":"string","description":"Comment, if any, provided by the approver."},"removeDate":{"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity.","format":"date-time","example":"2020-07-11T00:00:00Z"}}},"description":"Approval details for each item."},"manualWorkItemDetails":{"type":"array","items":{"type":"object","properties":{"forwarded":{"type":"boolean","description":"True if the request for this item was forwarded from one owner to another.","example":true},"originalOwner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Base identity/workgroup reference object representing the original owner, if forwarded."},"currentOwner":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Base reference of approver that will make decision."},"modified":{"type":"string","format":"date-time","description":"Time at which item was modified.","example":"2019-08-23T18:52:57.398Z"},"status":{"type":"string","enum":["PENDING","APPROVED","REJECTED","EXPIRED","CANCELLED","ARCHIVED"],"description":"Indicates the state of the request processing for this item:\n* PENDING: The request for this item is awaiting processing.\n* APPROVED: The request for this item has been approved.\n* REJECTED: The request for this item was rejected.\n* EXPIRED: The request for this item expired with no action taken.\n* CANCELLED: The request for this item was cancelled with no user action.\n* ARCHIVED: The request for this item has been archived after completion.","example":"PENDING"}}},"description":"Manual work items created for provisioning the item."},"accountActivityItemId":{"type":"string","description":"Id of associated account activity item.","example":"2c9180926cbfbddd016cbfc7c3b10010"},"requestType":{"type":"string","enum":["GRANT_ACCESS","REVOKE_ACCESS"],"description":"Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. Currently REVOKE_ACCESS is not supported for entitlements.","example":"GRANT_ACCESS"},"modified":{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"},"created":{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"},"requester":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity that requested the item."},"requestedFor":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"The identity for whom the Access Request Status is requested for."},"requesterComment":{"description":"The requester's comment.","type":"object","properties":{"comment":{"type":"string","description":"Content of the comment","example":"Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat"},"author":{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"ID of the author","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the identity making the comment","example":"Adam Kennedy"}}},"created":{"type":"string","format":"date-time","description":"Date and time comment was created","example":"2017-07-11T18:45:37.098Z"}}},"sodViolationContext":{"description":"The details of the SOD violations for the associated approval.","type":"object","properties":{"state":{"type":"string","enum":["SUCCESS","ERROR"],"description":"The status of SOD violation check","example":"SUCCESS"},"uuid":{"description":"The id of the Violation check event","type":"string","example":"f73d16e9-a038-46c5-b217-1246e15fdbdd"},"violationCheckResult":{"description":"The inner object representing the completed SOD Violation check","type":"object","properties":{"message":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}},"description":"If the request failed, includes any error message that was generated.","example":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An error has occurred during the SOD violation check"}]},"clientMetadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check.","example":{"requestedAppName":"test-app","requestedAppId":"2c91808f7892918f0178b78da4a305a1"}},"violationContexts":{"type":"array","items":{"description":"The contextual information of the violated criteria","type":"object","properties":{"policy":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the Policy that is being violated."},"conflictingAccessCriteria":{"type":"object","description":"The object which contains the left and right hand side of the entitlements that got violated according to the policy.","properties":{"leftCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}},"rightCriteria":{"type":"object","properties":{"criteriaList":{"type":"array","items":{"description":"Details of the Entitlement criteria","type":"object","properties":{"existing":{"type":"boolean","example":true,"description":"If the entitlement already belonged to the user or not."},"type":{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY"},"id":{"type":"string","description":"Entitlement ID","example":"2c918085771e9d3301773b3cb66f6398"},"name":{"type":"string","description":"Entitlement name","example":"My HR Entitlement"}}}}}}}}}}},"violatedPolicies":{"type":"array","description":"A list of the Policies that were violated","items":{"type":"object","properties":{"type":{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY"],"example":"IDENTITY"},"id":{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"},"name":{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}},"description":"Reference to the policy that was violated","example":[{"type":"SOD_POLICY","id":"69129440-422d-4a23-aadd-35c828d5bfda","name":"HR Policy"}]}}}}}},"provisioningDetails":{"type":"object","properties":{"orderedSubPhaseReferences":{"type":"string","description":"Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase.","example":"manualWorkItemDetails"}},"description":"Provides additional details about provisioning for this request."},"preApprovalTriggerDetails":{"type":"object","properties":{"comment":{"type":"string","description":"Comment left for the pre-approval decision","example":"Access is Approved"},"reviewer":{"type":"string","description":"The reviewer of the pre-approval decision","example":"John Doe"},"decision":{"type":"string","enum":["APPROVED","REJECTED"],"description":"The decision of the pre-approval trigger","example":"APPROVED"}},"description":"Provides additional details about the pre-approval trigger for this request."},"accessRequestPhases":{"type":"array","items":{"type":"object","properties":{"started":{"type":"string","description":"The time that this phase started.","format":"date-time","example":"2020-07-11T00:00:00Z"},"finished":{"type":"string","description":"The time that this phase finished.","format":"date-time","example":"2020-07-12T00:00:00Z"},"name":{"type":"string","description":"The name of this phase.","example":"APPROVAL_PHASE"},"state":{"type":"string","enum":["PENDING","EXECUTING","COMPLETED","CANCELLED"],"description":"The state of this phase.","example":"COMPLETED"},"result":{"type":"string","enum":["SUCCESSFUL","FAILED"],"description":"The state of this phase.","example":"SUCCESSFUL"},"phaseReference":{"type":"string","description":"A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items.","example":"approvalDetails"}},"description":"Provides additional details about this access request phase."},"description":"A list of Phases that the Access Request has gone through in order, to help determine the status of the request."},"description":{"type":"string","description":"Description associated to the requested object.","example":"This is the Engineering role that engineers are granted."},"removeDate":{"type":"string","format":"date-time","description":"When the role access is scheduled for removal.","example":"2019-10-23T00:00:00.000Z"},"cancelable":{"type":"boolean","description":"True if the request can be canceled.","example":true},"accessRequestId":{"type":"string","format":"uuid","description":"This is the account activity id.","example":"ef38f94347e94562b5bb8424a56397d8"}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"401":{"description":"Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"429":{"description":"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.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A message describing the error","example":" Rate Limit Exceeded "}}}}}},"500":{"description":"Internal Server Error - Returned if there is an unexpected error.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"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.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"500":{"summary":"An example of a 500 response object","value":{"detailCode":"500.0 Internal Fault","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"An internal fault occurred."}]}}}}}}},"method":"get","path":"/access-request-status","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/docs/authentication.html) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/docs/authentication.html#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/docs/authentication.html#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/docs/authentication.html#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/docs/authentication.html#which-oauth-2-0-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/docs/authentication.html#finding-your-tenant-s-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"contact":{"email":"developers@sailpoint.com","name":"Developer Relations","url":"https://developer.sailpoint.com/discuss"},"description":"These are the public, beta APIs for SailPoint's SaaS services and are subject to change.","title":"SailPoint - Beta SaaS API","version":"3.1.0-beta"},"postman":{"name":"Access Request Status","description":{"content":"The Access Request Status API returns a list of access request statuses based on the specified query parameters.\nAny token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users.","type":"text/plain"},"url":{"path":["access-request-status"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Filter the results by the identity for which the requests were made. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","type":"text/plain"},"key":"requested-for","value":""},{"disabled":false,"description":{"content":"Filter the results by the identity that made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*.","type":"text/plain"},"key":"requested-by","value":""},{"disabled":false,"description":{"content":"Filter the results by the specified identity which is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*.","type":"text/plain"},"key":"regarding-identity","value":""},{"disabled":false,"description":{"content":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.","type":"text/plain"},"key":"count","value":""},{"disabled":false,"description":{"content":"Max number of results to return.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.","type":"text/plain"},"key":"offset","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/sailpoint-api-beta/sail-point-beta-saa-s-api --- import ApiTabs from "@theme/ApiTabs"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem" import SchemaTabs from "@theme/SchemaTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import TabItem from "@theme/TabItem"; ## Access Request Status The Access Request Status API returns a list of access request statuses based on the specified query parameters. Any token with any authority can request their own status. A token with ORG_ADMIN authority is required to call this API to get a list of statuses for other users.
Query Parameters
List of requested item status.
Schema array
    cancelledRequestDetails object
    Provides additional details for a request that has been cancelled.
    owner object
    approvalDetails object[]
    Approval details for each item.
    originalOwner object
    Base identity/workgroup reference object representing the original owner, if forwarded.
    currentOwner object
    Base reference of approver that will make decision.
    reviewedBy object
    The identity who has reviewed the approval.
    errorMessages object[]
    If the request failed, includes any error messages that were generated.
    manualWorkItemDetails object[]
    Manual work items created for provisioning the item.
    originalOwner object
    Base identity/workgroup reference object representing the original owner, if forwarded.
    currentOwner object
    Base reference of approver that will make decision.
    requester object
    The identity that requested the item.
    requestedFor object
    The identity for whom the Access Request Status is requested for.
    requesterComment object
    The requester's comment.
    author object
    sodViolationContext object
    The details of the SOD violations for the associated approval.
    violationCheckResult object
    The inner object representing the completed SOD Violation check
    message object
    If the request failed, includes any error message that was generated.
    clientMetadata object
    Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check.
  • property name* string
    • violationContexts object[]
    policy object
    Reference to the Policy that is being violated.
    conflictingAccessCriteria object
    The object which contains the left and right hand side of the entitlements that got violated according to the policy.
    leftCriteria object
    criteriaList object[]
    rightCriteria object
    criteriaList object[]
    violatedPolicies object[]
    A list of the Policies that were violated
    provisioningDetails object
    Provides additional details about provisioning for this request.
    preApprovalTriggerDetails object
    Provides additional details about the pre-approval trigger for this request.
    accessRequestPhases object[]
    A list of Phases that the Access Request has gone through in order, to help determine the status of the request.
Client Error - Returned if the request body is invalid.
Schema
    messages object[]
    Generic localized reason for error
    causes object[]
    Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
Schema
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
Schema
    messages object[]
    Generic localized reason for error
    causes object[]
    Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
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.
Schema
Internal Server Error - Returned if there is an unexpected error.
Schema
    messages object[]
    Generic localized reason for error
    causes object[]
    Plain-text descriptive reasons to provide additional detail to the text provided in the messages field