Create Entitlements
Search
Search app entitlements based on filters specified in the request body.
Body Parameters
Search for app entitlements that are being reviewed as part of this access review campaign.
Search for app entitlements that have this alias (exact match).
Search for app entitlements contained in any of these apps.
Search for app entitlements that are granted to any of these app user ids.
Search for app entitlements that are part of these compliace frameworks.
The displayName field.
Exclude app entitlements from the results that are in these app IDs.
Exclude app entitlements from the results that these app users have granted.
The excludeResourceTypeIds field.
The app entitlement expand mask allows the user to get additional information when getting responses containing app entitlement views.
Include deleted app entitlements, this includes app entitlements that have a deleted parent object (app, app resource, app resource type)
The isAutomated field.
The membershipType field.
Restrict results to only those who have expiring app entitlement user bindings.
The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)
The pageToken field.
Query the app entitlements with a fuzzy search on display name and description.
The refs field.
Search for app entitlements that belongs to these resources.
The resourceTraitIds field.
Search for app entitlements that are for items with resources types that have matching names. Example names are "group", "role", and "app".
Search for app entitlements with these risk levels.
The sourceConnectorId field.
Returns
List of related objects.
Indicates one value of a facet.
List of app entitlement view objects.
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.
curl https://{tenantDomain}.conductor.one/api/v1/search/entitlements \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $CONDUCTORONE_SDK_API_KEY"{
"expanded": [
{
"@type": "@type"
}
],
"facets": {
"count": "count",
"facets": [
{
"displayName": "displayName",
"iconUrl": "iconUrl",
"param": "param",
"range": {
"ranges": [
{
"count": "count",
"displayName": "displayName",
"from": "from",
"iconUrl": "iconUrl",
"to": "to"
}
]
},
"value": {
"values": [
{
"count": "count",
"displayName": "displayName",
"iconUrl": "iconUrl",
"value": "value"
}
]
}
}
]
},
"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"
}