Update

Update

client.apps.entitlements.update(stringid, EntitlementUpdateParamsparams, RequestOptionsoptions?): appEntitlementViewC1APIAppV1AppEntitlementViewexpandedunionEntitlementUpdateResponse

post/api/v1/apps/{app_id}/entitlements/{id}

Update an app entitlement by ID.

Parameters

idstring

The unique ID for the App Entitlement.

paramsapp_idstringentitlementC1APIAppV1AppEntitlementexpandMaskC1APIAppV1AppEntitlementExpandMaskoverrideAccessRequestsDefaultsbooleanupdateMaskunionEntitlementUpdateParams

Hide ParametersShow Parameters

app_idstring

Path param: The ID of the app that is associated with the app entitlement.

entitlementidstringaliasstringappIdstringappResourceIdstringappResourceTypeIdstringcertifyPolicyIdstringcomplianceFrameworkValueIdsunioncreatedAtstringdefaultValuesAppliedbooleandeletedAtstringdeprovisionerPolicyC1APIPolicyV1ProvisionPolicydescriptionstringdisplayNamestringdurationGrantstringdurationUnsetunknownemergencyGrantEnabledbooleanemergencyGrantPolicyIdstringgrantCountstringgrantPolicyIdstringisAutomationEnabledbooleanisManuallyManagedbooleanmatchBatonIdstringoverrideAccessRequestsDefaultsbooleanprovisionerPolicyC1APIPolicyV1ProvisionPolicypurposeunionrevokePolicyIdstringriskLevelValueIdstringslugstringsourceConnectorIdsRecord<string, string>systemBuiltinbooleanupdatedAtstringuserEditedMaskunionC1APIAppV1AppEntitlement

optional

Body param: 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

expandMaskpathsunionC1APIAppV1AppEntitlementExpandMask

optional

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

overrideAccessRequestsDefaultsboolean

optional

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

updateMaskunion

optional

string | null

Body param:

Returns

EntitlementUpdateResponse

The UpdateAppEntitlementResponse message.

Hide ParametersShow Parameters

appEntitlementViewappEntitlementC1APIAppV1AppEntitlementappPathstringappResourcePathstringappResourceTypePathstringC1APIAppV1AppEntitlementView

optional

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

expandedunion

optional

Array<Expanded> | null

List of related objects

Hide ParametersShow Parameters

@typestring

optional

The type of the serialized message.

Request example TypeScript

import ConductoroneSDK from 'conductorone-sdk';

const client = new ConductoroneSDK({
  apiKey: 'My API Key',
});

const entitlement = await client.apps.entitlements.update('id', { app_id: 'app_id' });

console.log(entitlement.appEntitlementView);

200 Example

{
  "appEntitlementView": {
    "appEntitlement": {
      "alias": "alias",
      "appId": "appId",
      "appResourceId": "appResourceId",
      "appResourceTypeId": "appResourceTypeId",
      "certifyPolicyId": "certifyPolicyId",
      "complianceFrameworkValueIds": [
        "string"
      ],
      "defaultValuesApplied": true,
      "deprovisionerPolicy": {
        "connector": {
          "account": {
            "config": {
              "foo": "bar"
            },
            "connectorId": "connectorId",
            "doNotSave": {},
            "saveToVault": {
              "vaultIds": [
                "string"
              ]
            },
            "schemaId": "schemaId"
          },
          "defaultBehavior": {
            "connectorId": "connectorId"
          },
          "deleteAccount": {
            "connectorId": "connectorId"
          }
        },
        "delegated": {
          "appId": "appId",
          "entitlementId": "entitlementId",
          "implicit": true
        },
        "externalTicket": {
          "appId": "appId",
          "connectorId": "connectorId",
          "externalTicketProvisionerConfigId": "externalTicketProvisionerConfigId",
          "instructions": "instructions"
        },
        "manual": {
          "instructions": "instructions",
          "userIds": [
            "string"
          ]
        },
        "unconfigured": {},
        "webhook": {
          "webhookId": "webhookId"
        }
      },
      "description": "description",
      "displayName": "displayName",
      "durationGrant": "durationGrant",
      "durationUnset": {},
      "emergencyGrantEnabled": true,
      "emergencyGrantPolicyId": "emergencyGrantPolicyId",
      "grantPolicyId": "grantPolicyId",
      "isManuallyManaged": true,
      "matchBatonId": "matchBatonId",
      "overrideAccessRequestsDefaults": true,
      "provisionerPolicy": {
        "connector": {
          "account": {
            "config": {
              "foo": "bar"
            },
            "connectorId": "connectorId",
            "doNotSave": {},
            "saveToVault": {
              "vaultIds": [
                "string"
              ]
            },
            "schemaId": "schemaId"
          },
          "defaultBehavior": {
            "connectorId": "connectorId"
          },
          "deleteAccount": {
            "connectorId": "connectorId"
          }
        },
        "delegated": {
          "appId": "appId",
          "entitlementId": "entitlementId",
          "implicit": true
        },
        "externalTicket": {
          "appId": "appId",
          "connectorId": "connectorId",
          "externalTicketProvisionerConfigId": "externalTicketProvisionerConfigId",
          "instructions": "instructions"
        },
        "manual": {
          "instructions": "instructions",
          "userIds": [
            "string"
          ]
        },
        "unconfigured": {},
        "webhook": {
          "webhookId": "webhookId"
        }
      },
      "purpose": "APP_ENTITLEMENT_PURPOSE_VALUE_UNSPECIFIED",
      "revokePolicyId": "revokePolicyId",
      "riskLevelValueId": "riskLevelValueId",
      "slug": "slug",
      "sourceConnectorIds": {
        "foo": "string"
      },
      "userEditedMask": "userEditedMask"
    },
    "appPath": "appPath",
    "appResourcePath": "appResourcePath",
    "appResourceTypePath": "appResourceTypePath"
  },
  "expanded": [
    {
      "@type": "@type"
    }
  ]
}