Manage Advanced Settings Approvals and Checkout

The following APIs are used when a profile is configured with advanced settings for ITSM integration.

1. Create an Approval Request

This POST method creates an approval request.

Request Example 

curl --location -g --request POST '{{url}}/api/access/{{access_profile_id}}/environments/{{environment_id}}/approvalRequest' 
--header 'Authorization: TOKEN {{token}}'
{
    "justification" : "Adding IAM policy...",
    "ticketId" : "TEST-1",
    "ticketType" : "issue"
}

Response Example 

{
    "tenantId": "tddev",
    "userId": "0ud72g71l9d6u3ztmkkx",
    "status": "Pending",
    "appContainerId": "6nkbm12x9jowbox8m0d6",
    "statusText": "pending Approval",
    "papId": "1o0g1kufnv90tamu4qd4",
    "environmentId": "546836430071",
    "requestId": "cf53e118-09bc-437c-9be0-26b8f66b3247",
    "approvalValidityTime": null
}

2 Checkout Advanced Settings enabled Profile with Approval

Request Example

curl --location -g --request POST '{{url}}/api/access/{{access_profile_id}}/environments/{{environment_id}}?accessType={{access _type}}' 
--header 'Authorization: TOKEN {{token}}'

Response Example 

{
    "transactionId": "davidl-zceje5tyurwin7xntbqk1wc",
    "status": "checkOutSubmitted",
    "expiration": "2024-10-17T11:17:39Z",
    "checkedOut": "2024-10-17T11:02:39Z",
    "checkedIn": null,
    "currentExtensionIndex": 0,
    "environmentId": "546836430071",
    "accessType": "CONSOLE",
    "appContainerId": "6nkbm12x9jowbox8m0d6",
    "policyConditionEndTime": null,
    "errorMessage": null,
    "statusText": "Checkout Submitted",
    "papId": "1o0g1kufnv90tamu4qd4",
    "userId": "0ud72g71l9d6u3ztmkkx"
}

3 Checkout Advanced Settings enabled Profile without an Approval

Request Example

curl --location -g --request POST '{{url}}/api/access/{{access_profile_id}}/environments/{{environment_id}}?accessType={{access _type}}' 
--header 'Authorization: TOKEN {{token}}'

Response Example 

{
"justification" : "Adding IAM policy to AWS as a part of PAB-12345",
"ticketId" : "INC0000060",
"ticketType" : "incident"
}