- Print
- PDF
Manage Approvers Group
- Print
- PDF
1. Get all Approvers Group configured in the application
This method retrieves all approvers groups for the application.
GET | {{url}}/api/apps/{appId}/approvers-groups |
Request Parameters
curl --location --request GET '{{url}}/api/apps/{appId}/approvers-groups' \
--header 'Authorization: TOKEN {{token}}'
Request Parameters
The request parameter used in this method is shown in the following table:
Parameter | Description | Data Type | Required |
---|---|---|---|
appId | Id of the application | String | Mandatory |
Response Example
{
"approversGroupSummary":[
{
"id":"74a28c2d-cb24-4581-b1c3-184d5aae2f0c",
"name":"auto_agrp2_KyroO",
"condition":"Any",
"members":[
{
"id":"anxnurayz8yzj3pg5zpu",
"name":"Req-Tag",
"memberType":"Tag"
}
]
},
{
"id":"b51220f8-8351-4aa9-8c76-9b693d35ba8c",
"name":"auto_agrp_x56dg",
"condition":"Any",
"members":[
{
"id":"2wvor8nuyxw252vcc7fs",
"name":"test@britive.com",
"memberType":"User"
}
]
}
]
}
Status: 200 OK |
2. Create new Approvers Group for an application
The POST method creates a new approvers group.
POST | {{url}/api/apps/{appId}/approvers-groups |
Request Parameter
Parameter | Description | Data Type | Required |
---|---|---|---|
appId | Id of the application | String | Mandatory |
Request Parameters
An example POST request for creating a new approvers group is shown here.
curl --location --request POST '{{url}}/api/apps/{appId}/approvers-groups' \
--header 'Authorization: TOKEN {{token}}' {
"condition":"All",
"name":"test",
"members":[
{
"id":"0bzdrasb7xqc9nkaz0tl",
"name":"yogesh c",
"memberType":"User",
"firstName":"test",
"lastName":"test"
}
]
}
Response Example
{
"id" : "4ec6a3a6-d063-4775-85d4-3159d564fbae",
"name" : "test",
"condition" : "All",
"members" : [ {
"id" : "0bzdrasb7xqc9nkaz0tl",
"name" : "test",
"memberType" : "User"
} ]
}
Status: 200 OK |
3. Get Approvers Groups for given ID
The GET method retrieves the approvers groups for a given group ID.
GET | {{url}}/api/apps/{appId}/approvers-groups/{groupId} |
Request Parameters
Parameter | Description | Data Type | Required |
---|---|---|---|
appId | Id of the application | String | Mandatory |
groupId | Id of the approver group | String | Mandatory |
Request Example
curl --location --request GET '{{url}}/api/apps/{appId}/approvers-groups/{groupId}' \
--header 'Authorization: TOKEN {{token}}'
Response Example
{
"id" : "4ec6a3a6-d063-4775-85d4-3159d564fbae",
"name" : "test",
"condition" : "All",
"members" : [ {
"id" : "0bzdrasb7xqc9nkaz0tl",
"name" : "test",
"memberType" : "User"
} ]
}
Status: 200 OK |
4. Delete Approver Group for Access Builder Settings
DELETE | {{url}}/api/apps/{appId}/approvers-groups/{groupId} |
Request Parameter
Parameter | Description | Data Type | Required |
---|---|---|---|
appId | Id of the application | String | Mandatory |
groupId | Id of the approver group | String | Mandatory |
Request Example
curl --location --request DELETE '{{url}}/api/apps/{appId}/approvers-groups/{groupId}' \
--header 'Authorization: TOKEN {{token}}'
Status: 204 No Content |
5. Updates Approvers Group for given ID
PATCH | {{url}}/api/apps/{appId}/approvers-groups/{groupId} |
Request Parameter
The request parameters used in this method is shown in the following table:
Parameter | Description | Data Type | Required |
---|---|---|---|
appId | Id of the application | String | Mandatory |
groupId | Id of the approval group | String | Mandatory |
Request Example
curl --location --request PATCH '{{url}}/api/apps/{appId}/approvers-groups/{groupId}' \
--header 'Authorization: TOKEN {{token}}'{
"condition":"Any"
}
Response Example
Status: 204 No Content |