Retrieve

Get

client.apps.entitlements.retrieve(stringid, EntitlementRetrieveParamsparams, RequestOptionsoptions?): appEntitlementViewC1APIAppV1AppEntitlementViewexpandedunionEntitlementRetrieveResponse

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

Get an app entitlement by ID.

Parameters

idstring

The id field.

paramsapp_idstringEntitlementRetrieveParams

Hide ParametersShow Parameters

app_idstring

The appId field.

Returns

EntitlementRetrieveResponse

The get app entitlement response returns an entitlement view containing paths in the expanded array for the objects expanded as indicated by the expand mask in the request.

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 serialized 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.retrieve('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"
    }
  ]
}