Skip to main content
POST
/
api
/
v1
/
apps
/
{app_id}
/
entitlements
/
{id}
Update
package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.AppEntitlements.Update(ctx, operations.C1APIAppV1AppEntitlementsUpdateRequest{
        AppID: "<id>",
        ID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.UpdateAppEntitlementResponse != nil {
        // handle response
    }
}
import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.appEntitlements.update({
    appId: "<id>",
    id: "<id>",
  });

  console.log(result);
}

run();
curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/entitlements/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entitlement": {
    "alias": "<string>",
    "annotations": {},
    "appId": "<string>",
    "appResourceId": "<string>",
    "appResourceTypeId": "<string>",
    "certifyPolicyId": "<string>",
    "complianceFrameworkValueIds": [
      "<string>"
    ],
    "defaultValuesApplied": true,
    "deprovisionerPolicy": {
      "action": {
        "actionName": "<string>",
        "appId": "<string>",
        "connectorId": "<string>",
        "displayName": "<string>"
      },
      "connector": {
        "account": {
          "config": {},
          "connectorId": "<string>",
          "doNotSave": {},
          "saveToVault": {
            "vaultIds": [
              "<string>"
            ]
          },
          "schemaId": "<string>"
        },
        "defaultBehavior": {
          "connectorId": "<string>"
        },
        "deleteAccount": {
          "connectorId": "<string>"
        }
      },
      "delegated": {
        "appId": "<string>",
        "entitlementId": "<string>",
        "implicit": true
      },
      "externalTicket": {
        "appId": "<string>",
        "connectorId": "<string>",
        "externalTicketProvisionerConfigId": "<string>",
        "instructions": "<string>"
      },
      "manual": {
        "assignee": {
          "appOwners": {
            "allowReassignment": true,
            "fallbackUserIds": [
              "<string>"
            ]
          },
          "entitlementOwners": {
            "allowReassignment": true,
            "fallbackUserIds": [
              "<string>"
            ]
          },
          "expression": {
            "allowReassignment": true,
            "expressions": [
              "<string>"
            ],
            "fallbackUserIds": [
              "<string>"
            ]
          },
          "group": {
            "allowReassignment": true,
            "appGroupId": "<string>",
            "appId": "<string>",
            "fallbackUserIds": [
              "<string>"
            ]
          },
          "manager": {
            "allowReassignment": true,
            "fallbackUserIds": [
              "<string>"
            ]
          },
          "users": {
            "allowReassignment": true,
            "userIds": [
              "<string>"
            ]
          }
        },
        "instructions": "<string>",
        "userIds": [
          "<string>"
        ]
      },
      "multiStep": {
        "provisionSteps": "<array>"
      },
      "unconfigured": {},
      "webhook": {
        "webhookId": "<string>"
      }
    },
    "description": "<string>",
    "displayName": "<string>",
    "durationGrant": "<string>",
    "durationUnset": {},
    "emergencyGrantEnabled": true,
    "emergencyGrantPolicyId": "<string>",
    "grantPolicyId": "<string>",
    "isManuallyManaged": true,
    "matchBatonId": "<string>",
    "overrideAccessRequestsDefaults": true,
    "provisionerPolicy": {
      "action": {
        "actionName": "<string>",
        "appId": "<string>",
        "connectorId": "<string>",
        "displayName": "<string>"
      },
      "connector": {
        "account": {
          "config": {},
          "connectorId": "<string>",
          "doNotSave": {},
          "saveToVault": {
            "vaultIds": [
              "<string>"
            ]
          },
          "schemaId": "<string>"
        },
        "defaultBehavior": {
          "connectorId": "<string>"
        },
        "deleteAccount": {
          "connectorId": "<string>"
        }
      },
      "delegated": {
        "appId": "<string>",
        "entitlementId": "<string>",
        "implicit": true
      },
      "externalTicket": {
        "appId": "<string>",
        "connectorId": "<string>",
        "externalTicketProvisionerConfigId": "<string>",
        "instructions": "<string>"
      },
      "manual": {
        "assignee": {
          "appOwners": {
            "allowReassignment": true,
            "fallbackUserIds": [
              "<string>"
            ]
          },
          "entitlementOwners": {
            "allowReassignment": true,
            "fallbackUserIds": [
              "<string>"
            ]
          },
          "expression": {
            "allowReassignment": true,
            "expressions": [
              "<string>"
            ],
            "fallbackUserIds": [
              "<string>"
            ]
          },
          "group": {
            "allowReassignment": true,
            "appGroupId": "<string>",
            "appId": "<string>",
            "fallbackUserIds": [
              "<string>"
            ]
          },
          "manager": {
            "allowReassignment": true,
            "fallbackUserIds": [
              "<string>"
            ]
          },
          "users": {
            "allowReassignment": true,
            "userIds": [
              "<string>"
            ]
          }
        },
        "instructions": "<string>",
        "userIds": [
          "<string>"
        ]
      },
      "multiStep": {
        "provisionSteps": "<array>"
      },
      "unconfigured": {},
      "webhook": {
        "webhookId": "<string>"
      }
    },
    "requestSchemaId": "<string>",
    "revokePolicyId": "<string>",
    "riskLevelValueId": "<string>",
    "slug": "<string>",
    "sourceConnectorIds": {},
    "userEditedMask": "<string>"
  },
  "expandMask": {
    "paths": [
      "<string>"
    ]
  },
  "overrideAccessRequestsDefaults": true,
  "updateMask": "<string>"
}
'
import requests

url = "https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/entitlements/{id}"

payload = {
    "entitlement": {
        "alias": "<string>",
        "annotations": {},
        "appId": "<string>",
        "appResourceId": "<string>",
        "appResourceTypeId": "<string>",
        "certifyPolicyId": "<string>",
        "complianceFrameworkValueIds": ["<string>"],
        "defaultValuesApplied": True,
        "deprovisionerPolicy": {
            "action": {
                "actionName": "<string>",
                "appId": "<string>",
                "connectorId": "<string>",
                "displayName": "<string>"
            },
            "connector": {
                "account": {
                    "config": {},
                    "connectorId": "<string>",
                    "doNotSave": {},
                    "saveToVault": { "vaultIds": ["<string>"] },
                    "schemaId": "<string>"
                },
                "defaultBehavior": { "connectorId": "<string>" },
                "deleteAccount": { "connectorId": "<string>" }
            },
            "delegated": {
                "appId": "<string>",
                "entitlementId": "<string>",
                "implicit": True
            },
            "externalTicket": {
                "appId": "<string>",
                "connectorId": "<string>",
                "externalTicketProvisionerConfigId": "<string>",
                "instructions": "<string>"
            },
            "manual": {
                "assignee": {
                    "appOwners": {
                        "allowReassignment": True,
                        "fallbackUserIds": ["<string>"]
                    },
                    "entitlementOwners": {
                        "allowReassignment": True,
                        "fallbackUserIds": ["<string>"]
                    },
                    "expression": {
                        "allowReassignment": True,
                        "expressions": ["<string>"],
                        "fallbackUserIds": ["<string>"]
                    },
                    "group": {
                        "allowReassignment": True,
                        "appGroupId": "<string>",
                        "appId": "<string>",
                        "fallbackUserIds": ["<string>"]
                    },
                    "manager": {
                        "allowReassignment": True,
                        "fallbackUserIds": ["<string>"]
                    },
                    "users": {
                        "allowReassignment": True,
                        "userIds": ["<string>"]
                    }
                },
                "instructions": "<string>",
                "userIds": ["<string>"]
            },
            "multiStep": { "provisionSteps": "<array>" },
            "unconfigured": {},
            "webhook": { "webhookId": "<string>" }
        },
        "description": "<string>",
        "displayName": "<string>",
        "durationGrant": "<string>",
        "durationUnset": {},
        "emergencyGrantEnabled": True,
        "emergencyGrantPolicyId": "<string>",
        "grantPolicyId": "<string>",
        "isManuallyManaged": True,
        "matchBatonId": "<string>",
        "overrideAccessRequestsDefaults": True,
        "provisionerPolicy": {
            "action": {
                "actionName": "<string>",
                "appId": "<string>",
                "connectorId": "<string>",
                "displayName": "<string>"
            },
            "connector": {
                "account": {
                    "config": {},
                    "connectorId": "<string>",
                    "doNotSave": {},
                    "saveToVault": { "vaultIds": ["<string>"] },
                    "schemaId": "<string>"
                },
                "defaultBehavior": { "connectorId": "<string>" },
                "deleteAccount": { "connectorId": "<string>" }
            },
            "delegated": {
                "appId": "<string>",
                "entitlementId": "<string>",
                "implicit": True
            },
            "externalTicket": {
                "appId": "<string>",
                "connectorId": "<string>",
                "externalTicketProvisionerConfigId": "<string>",
                "instructions": "<string>"
            },
            "manual": {
                "assignee": {
                    "appOwners": {
                        "allowReassignment": True,
                        "fallbackUserIds": ["<string>"]
                    },
                    "entitlementOwners": {
                        "allowReassignment": True,
                        "fallbackUserIds": ["<string>"]
                    },
                    "expression": {
                        "allowReassignment": True,
                        "expressions": ["<string>"],
                        "fallbackUserIds": ["<string>"]
                    },
                    "group": {
                        "allowReassignment": True,
                        "appGroupId": "<string>",
                        "appId": "<string>",
                        "fallbackUserIds": ["<string>"]
                    },
                    "manager": {
                        "allowReassignment": True,
                        "fallbackUserIds": ["<string>"]
                    },
                    "users": {
                        "allowReassignment": True,
                        "userIds": ["<string>"]
                    }
                },
                "instructions": "<string>",
                "userIds": ["<string>"]
            },
            "multiStep": { "provisionSteps": "<array>" },
            "unconfigured": {},
            "webhook": { "webhookId": "<string>" }
        },
        "requestSchemaId": "<string>",
        "revokePolicyId": "<string>",
        "riskLevelValueId": "<string>",
        "slug": "<string>",
        "sourceConnectorIds": {},
        "userEditedMask": "<string>"
    },
    "expandMask": { "paths": ["<string>"] },
    "overrideAccessRequestsDefaults": True,
    "updateMask": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entitlement: {
      alias: '<string>',
      annotations: {},
      appId: '<string>',
      appResourceId: '<string>',
      appResourceTypeId: '<string>',
      certifyPolicyId: '<string>',
      complianceFrameworkValueIds: ['<string>'],
      defaultValuesApplied: true,
      deprovisionerPolicy: {
        action: {
          actionName: '<string>',
          appId: '<string>',
          connectorId: '<string>',
          displayName: '<string>'
        },
        connector: {
          account: {
            config: {},
            connectorId: '<string>',
            doNotSave: {},
            saveToVault: {vaultIds: ['<string>']},
            schemaId: '<string>'
          },
          defaultBehavior: {connectorId: '<string>'},
          deleteAccount: {connectorId: '<string>'}
        },
        delegated: {appId: '<string>', entitlementId: '<string>', implicit: true},
        externalTicket: {
          appId: '<string>',
          connectorId: '<string>',
          externalTicketProvisionerConfigId: '<string>',
          instructions: '<string>'
        },
        manual: {
          assignee: {
            appOwners: {allowReassignment: true, fallbackUserIds: ['<string>']},
            entitlementOwners: {allowReassignment: true, fallbackUserIds: ['<string>']},
            expression: {
              allowReassignment: true,
              expressions: ['<string>'],
              fallbackUserIds: ['<string>']
            },
            group: {
              allowReassignment: true,
              appGroupId: '<string>',
              appId: '<string>',
              fallbackUserIds: ['<string>']
            },
            manager: {allowReassignment: true, fallbackUserIds: ['<string>']},
            users: {allowReassignment: true, userIds: ['<string>']}
          },
          instructions: '<string>',
          userIds: ['<string>']
        },
        multiStep: {provisionSteps: '<array>'},
        unconfigured: {},
        webhook: {webhookId: '<string>'}
      },
      description: '<string>',
      displayName: '<string>',
      durationGrant: '<string>',
      durationUnset: {},
      emergencyGrantEnabled: true,
      emergencyGrantPolicyId: '<string>',
      grantPolicyId: '<string>',
      isManuallyManaged: true,
      matchBatonId: '<string>',
      overrideAccessRequestsDefaults: true,
      provisionerPolicy: {
        action: {
          actionName: '<string>',
          appId: '<string>',
          connectorId: '<string>',
          displayName: '<string>'
        },
        connector: {
          account: {
            config: {},
            connectorId: '<string>',
            doNotSave: {},
            saveToVault: {vaultIds: ['<string>']},
            schemaId: '<string>'
          },
          defaultBehavior: {connectorId: '<string>'},
          deleteAccount: {connectorId: '<string>'}
        },
        delegated: {appId: '<string>', entitlementId: '<string>', implicit: true},
        externalTicket: {
          appId: '<string>',
          connectorId: '<string>',
          externalTicketProvisionerConfigId: '<string>',
          instructions: '<string>'
        },
        manual: {
          assignee: {
            appOwners: {allowReassignment: true, fallbackUserIds: ['<string>']},
            entitlementOwners: {allowReassignment: true, fallbackUserIds: ['<string>']},
            expression: {
              allowReassignment: true,
              expressions: ['<string>'],
              fallbackUserIds: ['<string>']
            },
            group: {
              allowReassignment: true,
              appGroupId: '<string>',
              appId: '<string>',
              fallbackUserIds: ['<string>']
            },
            manager: {allowReassignment: true, fallbackUserIds: ['<string>']},
            users: {allowReassignment: true, userIds: ['<string>']}
          },
          instructions: '<string>',
          userIds: ['<string>']
        },
        multiStep: {provisionSteps: '<array>'},
        unconfigured: {},
        webhook: {webhookId: '<string>'}
      },
      requestSchemaId: '<string>',
      revokePolicyId: '<string>',
      riskLevelValueId: '<string>',
      slug: '<string>',
      sourceConnectorIds: {},
      userEditedMask: '<string>'
    },
    expandMask: {paths: ['<string>']},
    overrideAccessRequestsDefaults: true,
    updateMask: '<string>'
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/entitlements/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/entitlements/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'entitlement' => [
        'alias' => '<string>',
        'annotations' => [
                
        ],
        'appId' => '<string>',
        'appResourceId' => '<string>',
        'appResourceTypeId' => '<string>',
        'certifyPolicyId' => '<string>',
        'complianceFrameworkValueIds' => [
                '<string>'
        ],
        'defaultValuesApplied' => true,
        'deprovisionerPolicy' => [
                'action' => [
                                'actionName' => '<string>',
                                'appId' => '<string>',
                                'connectorId' => '<string>',
                                'displayName' => '<string>'
                ],
                'connector' => [
                                'account' => [
                                                                'config' => [
                                                                                                                                
                                                                ],
                                                                'connectorId' => '<string>',
                                                                'doNotSave' => [
                                                                                                                                
                                                                ],
                                                                'saveToVault' => [
                                                                                                                                'vaultIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ],
                                                                'schemaId' => '<string>'
                                ],
                                'defaultBehavior' => [
                                                                'connectorId' => '<string>'
                                ],
                                'deleteAccount' => [
                                                                'connectorId' => '<string>'
                                ]
                ],
                'delegated' => [
                                'appId' => '<string>',
                                'entitlementId' => '<string>',
                                'implicit' => true
                ],
                'externalTicket' => [
                                'appId' => '<string>',
                                'connectorId' => '<string>',
                                'externalTicketProvisionerConfigId' => '<string>',
                                'instructions' => '<string>'
                ],
                'manual' => [
                                'assignee' => [
                                                                'appOwners' => [
                                                                                                                                'allowReassignment' => true,
                                                                                                                                'fallbackUserIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ],
                                                                'entitlementOwners' => [
                                                                                                                                'allowReassignment' => true,
                                                                                                                                'fallbackUserIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ],
                                                                'expression' => [
                                                                                                                                'allowReassignment' => true,
                                                                                                                                'expressions' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ],
                                                                                                                                'fallbackUserIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ],
                                                                'group' => [
                                                                                                                                'allowReassignment' => true,
                                                                                                                                'appGroupId' => '<string>',
                                                                                                                                'appId' => '<string>',
                                                                                                                                'fallbackUserIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ],
                                                                'manager' => [
                                                                                                                                'allowReassignment' => true,
                                                                                                                                'fallbackUserIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ],
                                                                'users' => [
                                                                                                                                'allowReassignment' => true,
                                                                                                                                'userIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ]
                                ],
                                'instructions' => '<string>',
                                'userIds' => [
                                                                '<string>'
                                ]
                ],
                'multiStep' => [
                                'provisionSteps' => '<array>'
                ],
                'unconfigured' => [
                                
                ],
                'webhook' => [
                                'webhookId' => '<string>'
                ]
        ],
        'description' => '<string>',
        'displayName' => '<string>',
        'durationGrant' => '<string>',
        'durationUnset' => [
                
        ],
        'emergencyGrantEnabled' => true,
        'emergencyGrantPolicyId' => '<string>',
        'grantPolicyId' => '<string>',
        'isManuallyManaged' => true,
        'matchBatonId' => '<string>',
        'overrideAccessRequestsDefaults' => true,
        'provisionerPolicy' => [
                'action' => [
                                'actionName' => '<string>',
                                'appId' => '<string>',
                                'connectorId' => '<string>',
                                'displayName' => '<string>'
                ],
                'connector' => [
                                'account' => [
                                                                'config' => [
                                                                                                                                
                                                                ],
                                                                'connectorId' => '<string>',
                                                                'doNotSave' => [
                                                                                                                                
                                                                ],
                                                                'saveToVault' => [
                                                                                                                                'vaultIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ],
                                                                'schemaId' => '<string>'
                                ],
                                'defaultBehavior' => [
                                                                'connectorId' => '<string>'
                                ],
                                'deleteAccount' => [
                                                                'connectorId' => '<string>'
                                ]
                ],
                'delegated' => [
                                'appId' => '<string>',
                                'entitlementId' => '<string>',
                                'implicit' => true
                ],
                'externalTicket' => [
                                'appId' => '<string>',
                                'connectorId' => '<string>',
                                'externalTicketProvisionerConfigId' => '<string>',
                                'instructions' => '<string>'
                ],
                'manual' => [
                                'assignee' => [
                                                                'appOwners' => [
                                                                                                                                'allowReassignment' => true,
                                                                                                                                'fallbackUserIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ],
                                                                'entitlementOwners' => [
                                                                                                                                'allowReassignment' => true,
                                                                                                                                'fallbackUserIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ],
                                                                'expression' => [
                                                                                                                                'allowReassignment' => true,
                                                                                                                                'expressions' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ],
                                                                                                                                'fallbackUserIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ],
                                                                'group' => [
                                                                                                                                'allowReassignment' => true,
                                                                                                                                'appGroupId' => '<string>',
                                                                                                                                'appId' => '<string>',
                                                                                                                                'fallbackUserIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ],
                                                                'manager' => [
                                                                                                                                'allowReassignment' => true,
                                                                                                                                'fallbackUserIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ],
                                                                'users' => [
                                                                                                                                'allowReassignment' => true,
                                                                                                                                'userIds' => [
                                                                                                                                                                                                                                                                '<string>'
                                                                                                                                ]
                                                                ]
                                ],
                                'instructions' => '<string>',
                                'userIds' => [
                                                                '<string>'
                                ]
                ],
                'multiStep' => [
                                'provisionSteps' => '<array>'
                ],
                'unconfigured' => [
                                
                ],
                'webhook' => [
                                'webhookId' => '<string>'
                ]
        ],
        'requestSchemaId' => '<string>',
        'revokePolicyId' => '<string>',
        'riskLevelValueId' => '<string>',
        'slug' => '<string>',
        'sourceConnectorIds' => [
                
        ],
        'userEditedMask' => '<string>'
    ],
    'expandMask' => [
        'paths' => [
                '<string>'
        ]
    ],
    'overrideAccessRequestsDefaults' => true,
    'updateMask' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/entitlements/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entitlement\": {\n    \"alias\": \"<string>\",\n    \"annotations\": {},\n    \"appId\": \"<string>\",\n    \"appResourceId\": \"<string>\",\n    \"appResourceTypeId\": \"<string>\",\n    \"certifyPolicyId\": \"<string>\",\n    \"complianceFrameworkValueIds\": [\n      \"<string>\"\n    ],\n    \"defaultValuesApplied\": true,\n    \"deprovisionerPolicy\": {\n      \"action\": {\n        \"actionName\": \"<string>\",\n        \"appId\": \"<string>\",\n        \"connectorId\": \"<string>\",\n        \"displayName\": \"<string>\"\n      },\n      \"connector\": {\n        \"account\": {\n          \"config\": {},\n          \"connectorId\": \"<string>\",\n          \"doNotSave\": {},\n          \"saveToVault\": {\n            \"vaultIds\": [\n              \"<string>\"\n            ]\n          },\n          \"schemaId\": \"<string>\"\n        },\n        \"defaultBehavior\": {\n          \"connectorId\": \"<string>\"\n        },\n        \"deleteAccount\": {\n          \"connectorId\": \"<string>\"\n        }\n      },\n      \"delegated\": {\n        \"appId\": \"<string>\",\n        \"entitlementId\": \"<string>\",\n        \"implicit\": true\n      },\n      \"externalTicket\": {\n        \"appId\": \"<string>\",\n        \"connectorId\": \"<string>\",\n        \"externalTicketProvisionerConfigId\": \"<string>\",\n        \"instructions\": \"<string>\"\n      },\n      \"manual\": {\n        \"assignee\": {\n          \"appOwners\": {\n            \"allowReassignment\": true,\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"entitlementOwners\": {\n            \"allowReassignment\": true,\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"expression\": {\n            \"allowReassignment\": true,\n            \"expressions\": [\n              \"<string>\"\n            ],\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"group\": {\n            \"allowReassignment\": true,\n            \"appGroupId\": \"<string>\",\n            \"appId\": \"<string>\",\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"manager\": {\n            \"allowReassignment\": true,\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"users\": {\n            \"allowReassignment\": true,\n            \"userIds\": [\n              \"<string>\"\n            ]\n          }\n        },\n        \"instructions\": \"<string>\",\n        \"userIds\": [\n          \"<string>\"\n        ]\n      },\n      \"multiStep\": {\n        \"provisionSteps\": \"<array>\"\n      },\n      \"unconfigured\": {},\n      \"webhook\": {\n        \"webhookId\": \"<string>\"\n      }\n    },\n    \"description\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"durationGrant\": \"<string>\",\n    \"durationUnset\": {},\n    \"emergencyGrantEnabled\": true,\n    \"emergencyGrantPolicyId\": \"<string>\",\n    \"grantPolicyId\": \"<string>\",\n    \"isManuallyManaged\": true,\n    \"matchBatonId\": \"<string>\",\n    \"overrideAccessRequestsDefaults\": true,\n    \"provisionerPolicy\": {\n      \"action\": {\n        \"actionName\": \"<string>\",\n        \"appId\": \"<string>\",\n        \"connectorId\": \"<string>\",\n        \"displayName\": \"<string>\"\n      },\n      \"connector\": {\n        \"account\": {\n          \"config\": {},\n          \"connectorId\": \"<string>\",\n          \"doNotSave\": {},\n          \"saveToVault\": {\n            \"vaultIds\": [\n              \"<string>\"\n            ]\n          },\n          \"schemaId\": \"<string>\"\n        },\n        \"defaultBehavior\": {\n          \"connectorId\": \"<string>\"\n        },\n        \"deleteAccount\": {\n          \"connectorId\": \"<string>\"\n        }\n      },\n      \"delegated\": {\n        \"appId\": \"<string>\",\n        \"entitlementId\": \"<string>\",\n        \"implicit\": true\n      },\n      \"externalTicket\": {\n        \"appId\": \"<string>\",\n        \"connectorId\": \"<string>\",\n        \"externalTicketProvisionerConfigId\": \"<string>\",\n        \"instructions\": \"<string>\"\n      },\n      \"manual\": {\n        \"assignee\": {\n          \"appOwners\": {\n            \"allowReassignment\": true,\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"entitlementOwners\": {\n            \"allowReassignment\": true,\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"expression\": {\n            \"allowReassignment\": true,\n            \"expressions\": [\n              \"<string>\"\n            ],\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"group\": {\n            \"allowReassignment\": true,\n            \"appGroupId\": \"<string>\",\n            \"appId\": \"<string>\",\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"manager\": {\n            \"allowReassignment\": true,\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"users\": {\n            \"allowReassignment\": true,\n            \"userIds\": [\n              \"<string>\"\n            ]\n          }\n        },\n        \"instructions\": \"<string>\",\n        \"userIds\": [\n          \"<string>\"\n        ]\n      },\n      \"multiStep\": {\n        \"provisionSteps\": \"<array>\"\n      },\n      \"unconfigured\": {},\n      \"webhook\": {\n        \"webhookId\": \"<string>\"\n      }\n    },\n    \"requestSchemaId\": \"<string>\",\n    \"revokePolicyId\": \"<string>\",\n    \"riskLevelValueId\": \"<string>\",\n    \"slug\": \"<string>\",\n    \"sourceConnectorIds\": {},\n    \"userEditedMask\": \"<string>\"\n  },\n  \"expandMask\": {\n    \"paths\": [\n      \"<string>\"\n    ]\n  },\n  \"overrideAccessRequestsDefaults\": true,\n  \"updateMask\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/entitlements/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entitlement\": {\n    \"alias\": \"<string>\",\n    \"annotations\": {},\n    \"appId\": \"<string>\",\n    \"appResourceId\": \"<string>\",\n    \"appResourceTypeId\": \"<string>\",\n    \"certifyPolicyId\": \"<string>\",\n    \"complianceFrameworkValueIds\": [\n      \"<string>\"\n    ],\n    \"defaultValuesApplied\": true,\n    \"deprovisionerPolicy\": {\n      \"action\": {\n        \"actionName\": \"<string>\",\n        \"appId\": \"<string>\",\n        \"connectorId\": \"<string>\",\n        \"displayName\": \"<string>\"\n      },\n      \"connector\": {\n        \"account\": {\n          \"config\": {},\n          \"connectorId\": \"<string>\",\n          \"doNotSave\": {},\n          \"saveToVault\": {\n            \"vaultIds\": [\n              \"<string>\"\n            ]\n          },\n          \"schemaId\": \"<string>\"\n        },\n        \"defaultBehavior\": {\n          \"connectorId\": \"<string>\"\n        },\n        \"deleteAccount\": {\n          \"connectorId\": \"<string>\"\n        }\n      },\n      \"delegated\": {\n        \"appId\": \"<string>\",\n        \"entitlementId\": \"<string>\",\n        \"implicit\": true\n      },\n      \"externalTicket\": {\n        \"appId\": \"<string>\",\n        \"connectorId\": \"<string>\",\n        \"externalTicketProvisionerConfigId\": \"<string>\",\n        \"instructions\": \"<string>\"\n      },\n      \"manual\": {\n        \"assignee\": {\n          \"appOwners\": {\n            \"allowReassignment\": true,\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"entitlementOwners\": {\n            \"allowReassignment\": true,\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"expression\": {\n            \"allowReassignment\": true,\n            \"expressions\": [\n              \"<string>\"\n            ],\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"group\": {\n            \"allowReassignment\": true,\n            \"appGroupId\": \"<string>\",\n            \"appId\": \"<string>\",\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"manager\": {\n            \"allowReassignment\": true,\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"users\": {\n            \"allowReassignment\": true,\n            \"userIds\": [\n              \"<string>\"\n            ]\n          }\n        },\n        \"instructions\": \"<string>\",\n        \"userIds\": [\n          \"<string>\"\n        ]\n      },\n      \"multiStep\": {\n        \"provisionSteps\": \"<array>\"\n      },\n      \"unconfigured\": {},\n      \"webhook\": {\n        \"webhookId\": \"<string>\"\n      }\n    },\n    \"description\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"durationGrant\": \"<string>\",\n    \"durationUnset\": {},\n    \"emergencyGrantEnabled\": true,\n    \"emergencyGrantPolicyId\": \"<string>\",\n    \"grantPolicyId\": \"<string>\",\n    \"isManuallyManaged\": true,\n    \"matchBatonId\": \"<string>\",\n    \"overrideAccessRequestsDefaults\": true,\n    \"provisionerPolicy\": {\n      \"action\": {\n        \"actionName\": \"<string>\",\n        \"appId\": \"<string>\",\n        \"connectorId\": \"<string>\",\n        \"displayName\": \"<string>\"\n      },\n      \"connector\": {\n        \"account\": {\n          \"config\": {},\n          \"connectorId\": \"<string>\",\n          \"doNotSave\": {},\n          \"saveToVault\": {\n            \"vaultIds\": [\n              \"<string>\"\n            ]\n          },\n          \"schemaId\": \"<string>\"\n        },\n        \"defaultBehavior\": {\n          \"connectorId\": \"<string>\"\n        },\n        \"deleteAccount\": {\n          \"connectorId\": \"<string>\"\n        }\n      },\n      \"delegated\": {\n        \"appId\": \"<string>\",\n        \"entitlementId\": \"<string>\",\n        \"implicit\": true\n      },\n      \"externalTicket\": {\n        \"appId\": \"<string>\",\n        \"connectorId\": \"<string>\",\n        \"externalTicketProvisionerConfigId\": \"<string>\",\n        \"instructions\": \"<string>\"\n      },\n      \"manual\": {\n        \"assignee\": {\n          \"appOwners\": {\n            \"allowReassignment\": true,\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"entitlementOwners\": {\n            \"allowReassignment\": true,\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"expression\": {\n            \"allowReassignment\": true,\n            \"expressions\": [\n              \"<string>\"\n            ],\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"group\": {\n            \"allowReassignment\": true,\n            \"appGroupId\": \"<string>\",\n            \"appId\": \"<string>\",\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"manager\": {\n            \"allowReassignment\": true,\n            \"fallbackUserIds\": [\n              \"<string>\"\n            ]\n          },\n          \"users\": {\n            \"allowReassignment\": true,\n            \"userIds\": [\n              \"<string>\"\n            ]\n          }\n        },\n        \"instructions\": \"<string>\",\n        \"userIds\": [\n          \"<string>\"\n        ]\n      },\n      \"multiStep\": {\n        \"provisionSteps\": \"<array>\"\n      },\n      \"unconfigured\": {},\n      \"webhook\": {\n        \"webhookId\": \"<string>\"\n      }\n    },\n    \"requestSchemaId\": \"<string>\",\n    \"revokePolicyId\": \"<string>\",\n    \"riskLevelValueId\": \"<string>\",\n    \"slug\": \"<string>\",\n    \"sourceConnectorIds\": {},\n    \"userEditedMask\": \"<string>\"\n  },\n  \"expandMask\": {\n    \"paths\": [\n      \"<string>\"\n    ]\n  },\n  \"overrideAccessRequestsDefaults\": true,\n  \"updateMask\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "appEntitlementView": {
    "appEntitlement": {
      "alias": "<string>",
      "annotations": {},
      "appId": "<string>",
      "appResourceId": "<string>",
      "appResourceTypeId": "<string>",
      "certifyPolicyId": "<string>",
      "complianceFrameworkValueIds": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "defaultValuesApplied": true,
      "deletedAt": "2023-11-07T05:31:56Z",
      "deprovisionerPolicy": {
        "action": {
          "actionName": "<string>",
          "appId": "<string>",
          "connectorId": "<string>",
          "displayName": "<string>"
        },
        "connector": {
          "account": {
            "config": {},
            "connectorId": "<string>",
            "doNotSave": {},
            "saveToVault": {
              "vaultIds": [
                "<string>"
              ]
            },
            "schemaId": "<string>"
          },
          "defaultBehavior": {
            "connectorId": "<string>"
          },
          "deleteAccount": {
            "connectorId": "<string>"
          }
        },
        "delegated": {
          "appId": "<string>",
          "entitlementId": "<string>",
          "implicit": true
        },
        "externalTicket": {
          "appId": "<string>",
          "connectorId": "<string>",
          "externalTicketProvisionerConfigId": "<string>",
          "instructions": "<string>"
        },
        "manual": {
          "assignee": {
            "appOwners": {
              "allowReassignment": true,
              "fallbackUserIds": [
                "<string>"
              ]
            },
            "entitlementOwners": {
              "allowReassignment": true,
              "fallbackUserIds": [
                "<string>"
              ]
            },
            "expression": {
              "allowReassignment": true,
              "expressions": [
                "<string>"
              ],
              "fallbackUserIds": [
                "<string>"
              ]
            },
            "group": {
              "allowReassignment": true,
              "appGroupId": "<string>",
              "appId": "<string>",
              "fallbackUserIds": [
                "<string>"
              ]
            },
            "manager": {
              "allowReassignment": true,
              "fallbackUserIds": [
                "<string>"
              ]
            },
            "users": {
              "allowReassignment": true,
              "userIds": [
                "<string>"
              ]
            }
          },
          "instructions": "<string>",
          "userIds": [
            "<string>"
          ]
        },
        "multiStep": {
          "provisionSteps": "<array>"
        },
        "unconfigured": {},
        "webhook": {
          "webhookId": "<string>"
        }
      },
      "description": "<string>",
      "displayName": "<string>",
      "durationGrant": "<string>",
      "durationUnset": {},
      "emergencyGrantEnabled": true,
      "emergencyGrantPolicyId": "<string>",
      "externalId": "<string>",
      "grantCount": "<string>",
      "grantPolicyId": "<string>",
      "id": "<string>",
      "isAutomationEnabled": true,
      "isManuallyManaged": true,
      "matchBatonId": "<string>",
      "overrideAccessRequestsDefaults": true,
      "provisionerPolicy": {
        "action": {
          "actionName": "<string>",
          "appId": "<string>",
          "connectorId": "<string>",
          "displayName": "<string>"
        },
        "connector": {
          "account": {
            "config": {},
            "connectorId": "<string>",
            "doNotSave": {},
            "saveToVault": {
              "vaultIds": [
                "<string>"
              ]
            },
            "schemaId": "<string>"
          },
          "defaultBehavior": {
            "connectorId": "<string>"
          },
          "deleteAccount": {
            "connectorId": "<string>"
          }
        },
        "delegated": {
          "appId": "<string>",
          "entitlementId": "<string>",
          "implicit": true
        },
        "externalTicket": {
          "appId": "<string>",
          "connectorId": "<string>",
          "externalTicketProvisionerConfigId": "<string>",
          "instructions": "<string>"
        },
        "manual": {
          "assignee": {
            "appOwners": {
              "allowReassignment": true,
              "fallbackUserIds": [
                "<string>"
              ]
            },
            "entitlementOwners": {
              "allowReassignment": true,
              "fallbackUserIds": [
                "<string>"
              ]
            },
            "expression": {
              "allowReassignment": true,
              "expressions": [
                "<string>"
              ],
              "fallbackUserIds": [
                "<string>"
              ]
            },
            "group": {
              "allowReassignment": true,
              "appGroupId": "<string>",
              "appId": "<string>",
              "fallbackUserIds": [
                "<string>"
              ]
            },
            "manager": {
              "allowReassignment": true,
              "fallbackUserIds": [
                "<string>"
              ]
            },
            "users": {
              "allowReassignment": true,
              "userIds": [
                "<string>"
              ]
            }
          },
          "instructions": "<string>",
          "userIds": [
            "<string>"
          ]
        },
        "multiStep": {
          "provisionSteps": "<array>"
        },
        "unconfigured": {},
        "webhook": {
          "webhookId": "<string>"
        }
      },
      "requestSchemaId": "<string>",
      "revokePolicyId": "<string>",
      "riskLevelValueId": "<string>",
      "slug": "<string>",
      "sourceConnectorIds": {},
      "systemBuiltin": true,
      "updatedAt": "2023-11-07T05:31:56Z",
      "userEditedMask": "<string>"
    },
    "appPath": "<string>",
    "appResourcePath": "<string>",
    "appResourceTypePath": "<string>",
    "objectPermissions": {
      "delete": true,
      "edit": true,
      "extra": {},
      "read": true
    }
  },
  "expanded": [
    {
      "@type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

app_id
string
required

The ID of the app that is associated with the app entitlement.

id
string
required
read-only

The unique ID for the App Entitlement.

Body

application/json

The UpdateAppEntitlementRequest message contains the app entitlement and the fields to be updated.

entitlement
App Entitlement · object | null

The app entitlement represents one permission in a downstream App (SAAS) that can be granted. For example, GitHub Read vs GitHub Write.

This message contains a oneof named max_grant_duration. Only a single field of the following list may be set at a time:

  • durationUnset
  • durationGrant
expandMask
App Entitlement Expand Mask · object | null

The app entitlement expand mask allows the user to get additional information when getting responses containing app entitlement views.

overrideAccessRequestsDefaults
boolean | null

Flag to indicate that access request defaults, if any are applied to these entitlements, should be overridden.

updateMask
string | null

Response

200 - application/json

Successful response

The UpdateAppEntitlementResponse message.

appEntitlementView
App Entitlement View · object | null

The app entitlement view contains the serialized app entitlement and paths to objects referenced by the app entitlement.

expanded
object[] | null

List of related objects