Manage Profile Additional Settings

Note:

The following APIs are supported only for GCP, GCP Standalone and Azure applications only.

1. Get Profile Additional Settings

The GET method allows you to retrieve additional profile settings.

Request Example 

curl --location --request GET '{{url}}api/paps/{papId}/additional-settings' \
--header 'Authorization: TOKEN {{token}}' 

Response Example 

{
  "papId" : "s4h7rbh9yh045ktllzp8",
  "additionalSettings" : {
    "projectIdForServiceAccount" : "my-first-project",
    "consoleAccess" : true,
    "programmaticAccess" : true,
    "useApplicationCredentialType": false,
  }
}

2. Add or Update Profile Additional Settings

The POST method allows you to add or update profile additional settings. You can use this API to update all the settings. If a setting is not provided, it will be removed.

Request Example 

curl --location --request POST '{{url}}/api/paps/{papId}/additional-settings' \
--header 'Authorization: TOKEN {{token}}' \
--data-raw '[
{
    "projectIdForServiceAccount" : "my-first-project",
    "consoleAccess" : true,
    "programmaticAccess" : true,
    "useApplicationCredentialType": false,
}

Response Example 

3. Update a Specific Setting

The PATCH method allows you to update any specific profile's additional setting.

Request Example 

curl --location --request PATCH '{{url}}/api/paps/{papId}/additional-settings' \
--header 'Authorization: TOKEN {{token}}' \
--data-raw '[
{
    "projectIdForServiceAccount" : "my-first-project",
}

Response Example