Access Builder Settings

1. Get Access Builder Settings

This method retrieves the access builder settings.

curl --location --request GET '{{url}}/api/apps/{appId}/access-request-settings' \
--header 'Authorization: TOKEN {{token}}'

The request parameter used in this method is shown in the following table:

{
    "allowAccessRequest" : false,
    "associationApprovers" : [ {
      "id" : "bfd84a78-0ff2-4cf9-886b-05a2a563441c",
      "name" : "testaap",
      "associations" : [ {
        "id" : "ou-pak3-slpfjl4r",
        "type" : 1
      } ],
      "approversGroups" : [ {
        "id" : "74a28c2d-cb24-4581-b1c3-184d5aae2f0c",
        "name" : "auto_agrp2_KyroO",
        "condition" : "Any",
        "members" : [ {
          "id" : "anxnurayz8yzj3pg5zpu",
          "name" : "Req-Tag",
          "memberType" : "Tag"
        } ]
      } ]
    } ],
    "approvalTimeOut" : "00:05:00",
    "profileExpirationTimeout" : "600",
    "notificationMediums" : [ {
      "id" : "cfb6808b-db60-4be4-a842-94d92b6d0e69",
      "name" : "Email",
      "description" : "Default Email Notification Medium",
      "application" : "email",
      "channels" : null
    } ],
    "memberRules" : [ ]
  }

2. Configure Access Builder Settings

The POST method configures access builder settings for an application.

Request Parameter

curl --location --request POST '{{url}}/api/apps/{appId}/access-request-settings' \
--header 'Authorization: TOKEN {{token}}'{
        "notificationMediums": [
          {
            "id": "cfb6808b-db60-4be4-a842-94d92b6d0e69",
            "name": "Email",
            "description": "Default Email Notification Medium",
            "type": "email",
            "connectionParameters": null,
            "referenceCount": 0,
            "application": "email"
          }
        ]
      }

{
        "allowAccessRequest" : false,
        "associationApprovers" : [ ],
        "approvalTimeOut" : null,
        "profileExpirationTimeout" : null,
        "notificationMediums" : [ {
          "id" : "cfb6808b-db60-4be4-a842-94d92b6d0e69",
          "name" : "Email",
          "description" : "Default Email Notification Medium",
          "application" : "email",
          "channels" : null
        } ],
        "memberRules" : [ ]
 }

3. Update Access Builder Settings

The PATCH method updates the access request settings.

curl --location --request PATCH '{{url}}/api/apps/{appId}/access-request-settings' \
--header 'Authorization: TOKEN {{token}}'{
   "memberRules":[
      {
         "id":"0bzdrasb7xqc9nkaz0tl",
         "condition":"Include",
         "name":"testuser",
         "memberType":"User",
         "firstName":"yogesh",
         "lastName":"c"
      }
   ]
}