v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-224341,4072.0 MB
App Entitlement

Search

Search app entitlements based on filters specified in the request body.

post/api/v1/search/entitlements

Request body

accessReviewIdstring

Search for app entitlements that are being reviewed as part of this access review campaign.

aliasstring

Search for app entitlements that have this alias (exact match).

appIdsstring[] nullable

Search for app entitlements contained in any of these apps.

appUserIdsstring[] nullable

Search for app entitlements that are granted to any of these app user ids.

complianceFrameworkIdsstring[] nullable

Search for app entitlements that are part of these compliance frameworks.

displayNamestring

Filter results to entitlements with this exact display name.

excludeAppIdsstring[] nullable

Exclude app entitlements from the results that are in these app IDs.

excludeAppUserIdsstring[] nullable

Exclude entitlements from results that are granted to any of these app users.

excludeImmutableboolean

If true, exclude immutable entitlements (e.g., system-managed entitlements that cannot be modified).

excludeResourceTypeIdsstring[] nullable

Exclude entitlements with any of these resource type IDs from results.

includeDeletedboolean

Include deleted app entitlements, this includes app entitlements that have a deleted parent object (app, app resource, app resource type)

isAutomatedboolean

If true, restrict results to entitlements that have an automation rule configured.

membershipTypestring[] nullable

Filter results to entitlements where the user has any of these membership types (e.g., member, owner, admin).

onlyGetExpiringboolean

If true, restrict results to entitlements that have at least one expiring grant.

pageSizeinteger

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

pageTokenstring

The pageToken field.

querystring

Query the app entitlements with a fuzzy search on display name and description.

requestSchemaIdsstring[] nullable

Search for app entitlements that are bound to any of these request schemas.

resourceIdsstring[] nullable

Search for app entitlements that belongs to these resources.

resourceTraitIdsstring[] nullable

Filter results to entitlements whose resource types have any of these trait IDs.

resourceTypeIdsstring[] nullable

Search for app entitlements that are for items with resources types that have matching names. Example names are "group", "role", and "app".

riskLevelIdsstring[] nullable

Search for app entitlements with these risk levels.

sourceConnectorIdstring

Filter results to entitlements synced from this connector.

Response

Successful response

nextPageTokenstring

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.