Skip to content
  • Auto
  • Light
  • Dark
Get Started

List Requestable Entitlements

List Entitlements Per Catalog
get/api/v1/catalogs/{catalog_id}/requestable_entitlements

List entitlements in a catalog that are requestable.

Path Parameters
catalog_idstring

The catalogId field.

Query Parameters
page_sizenumber
optional

The pageSize field.

formatint32
page_tokenstring
optional

The pageToken field.

Returns
expandedarray of object
optional

List of serialized related objects.

Hide ParametersShow Parameters
@typestring
optional

The type of the serialized message.

listarray of appEntitlementC1APIAppV1AppEntitlementappPathstringappResourcePathstringappResourceTypePathstringC1APIAppV1AppEntitlementView
optional

The list of results containing up to X results, where X is the page size defined in the request.

nextPageTokenstring
optional

The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.

Request example cURL
curl https://{tenantDomain}.conductor.one/api/v1/catalogs/$CATALOG_ID/requestable_entitlements \
    -H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"
200 Example
{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "list": [
    {
      "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"
    }
  ],
  "nextPageToken": "nextPageToken"
}