Access Request Status
GET {{baseUrl}}/access-request-status
Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. 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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
requested-for | string | Filter the results by the identity the requests were made for. me indicates the current user. Mutually exclusive with regarding-identity. | |
requested-by | string | Filter the results by the identity twho made the requests. me indicates the current user. Mutually exclusive with regarding-identity. | |
regarding-identity | string | Filter the results by the specified identity who is either the requester or target of the requests. me indicates the current user. Mutually exclusive with requested-for and requested-by. | |
assigned-to | string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. me indicates the current user. | |
count | boolean | If this is true, the X-Total-Count response header populates with the number of results that would be returned if limit and offset were ignored. | |
limit | number | Max number of results to return. | |
offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. Defaults to 0 if not specified. | |
filters | string | Filter results using the standard syntax described in V3 API Standard Collection Parameters |
Filtering is supported for the following fields and operators:
accountActivityItemId: eq, in, ge, gt, le, lt, ne, isnull, sw |
| sorters | string | | Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: created, modified, accountActivityItemId, name |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"name":"AccessProfile1","type":"ACCESS_PROFILE","cancelledRequestDetails":{"comment":"This request must be cancelled.","owner":{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"Support"},"modified":"2019-12-20T09:17:12.192Z"},"errorMessages":[[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."},{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."}],[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."},{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."}]],"state":"EXECUTING","approvalDetails":[{"forwarded":false,"originalOwner":{"type":"IDENTITY","id":"2c7180a46faadee4016fb4e018c20642","name":"Michael Michaels"},"currentOwner":{"type":"IDENTITY","id":"2c3780a46faadee4016fb4e018c20652","name":"Allen Albertson"},"modified":"2019-08-23T18:52:57.398Z","status":"PENDING","scheme":"MANAGER","errorMessages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."},{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."}],"comment":"I approve this request","removeDate":"2020-07-11T00:00:00Z"},{"forwarded":false,"originalOwner":{"type":"IDENTITY","id":"2c7180a46faadee4016fb4e018c20642","name":"Michael Michaels"},"currentOwner":{"type":"IDENTITY","id":"2c3780a46faadee4016fb4e018c20652","name":"Allen Albertson"},"modified":"2019-08-23T18:52:57.398Z","status":"PENDING","scheme":"MANAGER","errorMessages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."},{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."}],"comment":"I approve this request","removeDate":"2020-07-11T00:00:00Z"}],"manualWorkItemDetails":[{"forwarded":true,"originalOwner":{"type":"IDENTITY","id":"2c7180a46faadee4016fb4e018c20642","name":"Michael Michaels"},"currentOwner":{"type":"IDENTITY","id":"2c3780a46faadee4016fb4e018c20652","name":"Allen Albertson"},"modified":"2019-08-23T18:52:57.398Z","status":"PENDING","forwardHistory":[{"oldApproverName":"Frank Mir","newApproverName":"Al Volta","comment":"Forwarding from Frank to Al","modified":"2019-08-23T18:52:57.398Z","forwarderName":"William Wilson","reassignmentType":"AUTOMATIC_REASSIGNMENT"},{"oldApproverName":"Frank Mir","newApproverName":"Al Volta","comment":"Forwarding from Frank to Al","modified":"2019-08-23T18:52:57.398Z","forwarderName":"William Wilson","reassignmentType":"AUTOMATIC_REASSIGNMENT"}]},{"forwarded":true,"originalOwner":{"type":"IDENTITY","id":"2c7180a46faadee4016fb4e018c20642","name":"Michael Michaels"},"currentOwner":{"type":"IDENTITY","id":"2c3780a46faadee4016fb4e018c20652","name":"Allen Albertson"},"modified":"2019-08-23T18:52:57.398Z","status":"PENDING","forwardHistory":[{"oldApproverName":"Frank Mir","newApproverName":"Al Volta","comment":"Forwarding from Frank to Al","modified":"2019-08-23T18:52:57.398Z","forwarderName":"William Wilson","reassignmentType":"AUTOMATIC_REASSIGNMENT"},{"oldApproverName":"Frank Mir","newApproverName":"Al Volta","comment":"Forwarding from Frank to Al","modified":"2019-08-23T18:52:57.398Z","forwarderName":"William Wilson","reassignmentType":"AUTOMATIC_REASSIGNMENT"}]}],"accountActivityItemId":"2c9180926cbfbddd016cbfc7c3b10010","requestType":"GRANT_ACCESS","modified":"2019-08-23T18:52:59.162Z","created":"2019-08-23T18:40:35.772Z","requester":{"type":"IDENTITY","id":"2c7180a46faadee4016fb4e018c20648","name":"William Wilson"},"requestedFor":{"type":"IDENTITY","id":"2c9180835d191a86015d28455b4b232a","name":"William Wilson"},"requesterComment":{"comment":"This is a comment.","created":"2017-07-11T18:45:37.098Z","author":{"type":"IDENTITY","id":"2c9180847e25f377017e2ae8cae4650b","name":"john.doe"}},"sodViolationContext":{"state":"SUCCESS","uuid":"f73d16e9-a038-46c5-b217-1246e15fdbdd","violationCheckResult":{"message":{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."},"clientMetadata":{"requestedAppName":"test-app","requestedAppId":"2c91808f7892918f0178b78da4a305a1"},"violationContexts":[{"policy":{"type":"SOD_POLICY","id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Business SOD Policy"},"conflictingAccessCriteria":{"leftCriteria":{"criteriaList":[{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"},{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"}]},"rightCriteria":{"criteriaList":[{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"},{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"}]}}},{"policy":{"type":"SOD_POLICY","id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Business SOD Policy"},"conflictingAccessCriteria":{"leftCriteria":{"criteriaList":[{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"},{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"}]},"rightCriteria":{"criteriaList":[{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"},{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"}]}}}],"violatedPolicies":[{"type":"SOD_POLICY","id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Business SOD Policy"},{"type":"SOD_POLICY","id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Business SOD Policy"}]}},"provisioningDetails":{"orderedSubPhaseReferences":"manualWorkItemDetails"},"preApprovalTriggerDetails":{"comment":"Access is Approved","reviewer":"John Doe","decision":"APPROVED"},"accessRequestPhases":[{"started":"2020-07-11T00:00:00Z","finished":"2020-07-12T00:00:00Z","name":"APPROVAL_PHASE","state":"COMPLETED","result":"SUCCESSFUL","phaseReference":"approvalDetails"},{"started":"2020-07-11T00:00:00Z","finished":"2020-07-12T00:00:00Z","name":"APPROVAL_PHASE","state":"COMPLETED","result":"SUCCESSFUL","phaseReference":"approvalDetails"}],"description":"This is the Engineering role that engineers are granted.","removeDate":"2019-10-23T00:00:00.000Z","cancelable":true,"accessRequestId":"2b838de9-db9b-abcf-e646-d4f274ad4238","clientMetadata":{"key1":"value1","key2":"value2"}},{"name":"AccessProfile1","type":"ACCESS_PROFILE","cancelledRequestDetails":{"comment":"This request must be cancelled.","owner":{"type":"IDENTITY","id":"2c9180a46faadee4016fb4e018c20639","name":"Support"},"modified":"2019-12-20T09:17:12.192Z"},"errorMessages":[[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."},{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."}],[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."},{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."}]],"state":"EXECUTING","approvalDetails":[{"forwarded":false,"originalOwner":{"type":"IDENTITY","id":"2c7180a46faadee4016fb4e018c20642","name":"Michael Michaels"},"currentOwner":{"type":"IDENTITY","id":"2c3780a46faadee4016fb4e018c20652","name":"Allen Albertson"},"modified":"2019-08-23T18:52:57.398Z","status":"PENDING","scheme":"MANAGER","errorMessages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."},{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."}],"comment":"I approve this request","removeDate":"2020-07-11T00:00:00Z"},{"forwarded":false,"originalOwner":{"type":"IDENTITY","id":"2c7180a46faadee4016fb4e018c20642","name":"Michael Michaels"},"currentOwner":{"type":"IDENTITY","id":"2c3780a46faadee4016fb4e018c20652","name":"Allen Albertson"},"modified":"2019-08-23T18:52:57.398Z","status":"PENDING","scheme":"MANAGER","errorMessages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."},{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."}],"comment":"I approve this request","removeDate":"2020-07-11T00:00:00Z"}],"manualWorkItemDetails":[{"forwarded":true,"originalOwner":{"type":"IDENTITY","id":"2c7180a46faadee4016fb4e018c20642","name":"Michael Michaels"},"currentOwner":{"type":"IDENTITY","id":"2c3780a46faadee4016fb4e018c20652","name":"Allen Albertson"},"modified":"2019-08-23T18:52:57.398Z","status":"PENDING","forwardHistory":[{"oldApproverName":"Frank Mir","newApproverName":"Al Volta","comment":"Forwarding from Frank to Al","modified":"2019-08-23T18:52:57.398Z","forwarderName":"William Wilson","reassignmentType":"AUTOMATIC_REASSIGNMENT"},{"oldApproverName":"Frank Mir","newApproverName":"Al Volta","comment":"Forwarding from Frank to Al","modified":"2019-08-23T18:52:57.398Z","forwarderName":"William Wilson","reassignmentType":"AUTOMATIC_REASSIGNMENT"}]},{"forwarded":true,"originalOwner":{"type":"IDENTITY","id":"2c7180a46faadee4016fb4e018c20642","name":"Michael Michaels"},"currentOwner":{"type":"IDENTITY","id":"2c3780a46faadee4016fb4e018c20652","name":"Allen Albertson"},"modified":"2019-08-23T18:52:57.398Z","status":"PENDING","forwardHistory":[{"oldApproverName":"Frank Mir","newApproverName":"Al Volta","comment":"Forwarding from Frank to Al","modified":"2019-08-23T18:52:57.398Z","forwarderName":"William Wilson","reassignmentType":"AUTOMATIC_REASSIGNMENT"},{"oldApproverName":"Frank Mir","newApproverName":"Al Volta","comment":"Forwarding from Frank to Al","modified":"2019-08-23T18:52:57.398Z","forwarderName":"William Wilson","reassignmentType":"AUTOMATIC_REASSIGNMENT"}]}],"accountActivityItemId":"2c9180926cbfbddd016cbfc7c3b10010","requestType":"GRANT_ACCESS","modified":"2019-08-23T18:52:59.162Z","created":"2019-08-23T18:40:35.772Z","requester":{"type":"IDENTITY","id":"2c7180a46faadee4016fb4e018c20648","name":"William Wilson"},"requestedFor":{"type":"IDENTITY","id":"2c9180835d191a86015d28455b4b232a","name":"William Wilson"},"requesterComment":{"comment":"This is a comment.","created":"2017-07-11T18:45:37.098Z","author":{"type":"IDENTITY","id":"2c9180847e25f377017e2ae8cae4650b","name":"john.doe"}},"sodViolationContext":{"state":"SUCCESS","uuid":"f73d16e9-a038-46c5-b217-1246e15fdbdd","violationCheckResult":{"message":{"locale":"en-US","localeOrigin":"DEFAULT","text":"The request was syntactically correct but its content is semantically invalid."},"clientMetadata":{"requestedAppName":"test-app","requestedAppId":"2c91808f7892918f0178b78da4a305a1"},"violationContexts":[{"policy":{"type":"SOD_POLICY","id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Business SOD Policy"},"conflictingAccessCriteria":{"leftCriteria":{"criteriaList":[{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"},{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"}]},"rightCriteria":{"criteriaList":[{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"},{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"}]}}},{"policy":{"type":"SOD_POLICY","id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Business SOD Policy"},"conflictingAccessCriteria":{"leftCriteria":{"criteriaList":[{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"},{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"}]},"rightCriteria":{"criteriaList":[{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"},{"existing":true,"type":"ENTITLEMENT","id":"2c918085771e9d3301773b3cb66f6398","name":"My HR Entitlement"}]}}}],"violatedPolicies":[{"type":"SOD_POLICY","id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Business SOD Policy"},{"type":"SOD_POLICY","id":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","name":"Business SOD Policy"}]}},"provisioningDetails":{"orderedSubPhaseReferences":"manualWorkItemDetails"},"preApprovalTriggerDetails":{"comment":"Access is Approved","reviewer":"John Doe","decision":"APPROVED"},"accessRequestPhases":[{"started":"2020-07-11T00:00:00Z","finished":"2020-07-12T00:00:00Z","name":"APPROVAL_PHASE","state":"COMPLETED","result":"SUCCESSFUL","phaseReference":"approvalDetails"},{"started":"2020-07-11T00:00:00Z","finished":"2020-07-12T00:00:00Z","name":"APPROVAL_PHASE","state":"COMPLETED","result":"SUCCESSFUL","phaseReference":"approvalDetails"}],"description":"This is the Engineering role that engineers are granted.","removeDate":"2019-10-23T00:00:00.000Z","cancelable":true,"accessRequestId":"2b838de9-db9b-abcf-e646-d4f274ad4238","clientMetadata":{"key1":"value1","key2":"value2"}}]