Skip to content
  • Auto
  • Light
  • Dark
Get Started

Create Entitlements

Search Entitlements
post/api/v1/search/request_catalog/entitlements

Search request catalogs based on filters specified in the request body.

Body Parameters
appDisplayNamestring
optional

Search entitlements that belong to this app name (exact match).

entitlementAliasstring
optional

Search for entitlements with this alias (exact match).

expandMaskpathsarray of stringC1APIAppV1AppEntitlementExpandMask
optional

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

grantedStatusenum
optional
"UNSPECIFIED" OR "ALL" OR "GRANTED" OR "NOT_GRANTED"

Search entitlements with this granted status for your signed in user.

Hide ParametersShow Parameters
"UNSPECIFIED"
"ALL"
"GRANTED"
"NOT_GRANTED"
includeDeletedboolean
optional

Include deleted entitlements

pageSizenumber
optional

The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)

formatint32
pageTokenstring
optional

The pageToken field.

querystring
optional

Fuzzy search the display name of resource types.

Returns
expandedarray of object
optional

List of serialized related objects.

Hide ParametersShow Parameters
@typestring
optional

The type of the serialized message.

listarray of object
optional

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

Hide ParametersShow Parameters
appEntitlementUserBindingsarray of appEntitlementIdstringappIdstringappUserIdstringcreatedAtstringdeletedAtstringdeprovisionAtstringgrantSourcesarray of AppEntitlementRefC1APIAppV1AppEntitlementUserBinding
optional

An array of AppEntitlementUserBinding objects which represent the relationships that give app users access to the specific app entitlement.

entitlementappEntitlementC1APIAppV1AppEntitlementappPathstringappResourcePathstringappResourceTypePathstringC1APIAppV1AppEntitlementView
optional

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

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/search/request_catalog/entitlements \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"
200 Example
{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "list": [
    {
      "appEntitlementUserBindings": [
        {
          "appEntitlementId": "appEntitlementId",
          "appId": "appId",
          "appUserId": "appUserId",
          "grantSources": [
            {
              "id": "id",
              "appId": "appId"
            }
          ]
        }
      ],
      "entitlement": {
        "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"
}