Update

Update

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

Update an app entitlement by ID.

Path Parameters

app_idstring

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

idstring

The unique ID for the App Entitlement.

Body Parameters

entitlementidstringaliasstringappIdstringappResourceIdstringappResourceTypeIdstringcertifyPolicyIdstringcomplianceFrameworkValueIdsarray of stringcreatedAtstringdefaultValuesAppliedbooleandeletedAtstringdeprovisionerPolicyC1APIPolicyV1ProvisionPolicydescriptionstringdisplayNamestringdurationGrantstringdurationUnsetunknownemergencyGrantEnabledbooleanemergencyGrantPolicyIdstringgrantCountstringgrantPolicyIdstringisAutomationEnabledbooleanisManuallyManagedbooleanmatchBatonIdstringoverrideAccessRequestsDefaultsbooleanprovisionerPolicyC1APIPolicyV1ProvisionPolicypurposeenumrevokePolicyIdstringriskLevelValueIdstringslugstringsourceConnectorIdsmapsystemBuiltinbooleanupdatedAtstringuserEditedMaskstringC1APIAppV1AppEntitlement

optional

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

expandMaskpathsarray of stringC1APIAppV1AppEntitlementExpandMask

optional

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

overrideAccessRequestsDefaultsboolean

optional

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

updateMaskstring

optional

Returns

appEntitlementViewappEntitlementC1APIAppV1AppEntitlementappPathstringappResourcePathstringappResourceTypePathstringC1APIAppV1AppEntitlementView

optional

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

expandedarray of object

optional

List of related objects

Hide ParametersShow Parameters

@typestring

optional

The type of the serialized message.

Request example cURL

curl https://{tenantDomain}.conductor.one/api/v1/apps/$APP_ID/entitlements/$ID \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"

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"
    }
  ]
}