List available entitlements | Atomicwork

List the entitlements (groups, roles, licenses, repos) available for granting. Each entitlement belongs to an app and represents a specific access right that can be assigned to a user.

Filter by app: Pass app_id (from GET /iga/apps) to list only entitlements under a specific identity provider app.

Filter by type: Use the type parameter to narrow by entitlement category:

GROUP — identity provider group membership (e.g. Azure AD security group, Okta group)
ROLE — application role assignment

Filter by status: Use status to filter by publication state:

PUBLISHED — available for granting
DRAFT — not yet available

Pagination: Supports page, per_page (default 25), and search_key for name search.

List the entitlements (groups, roles, licenses, repos) available for granting. Each entitlement belongs to an app and represents a specific access right that can be assigned to a user. **Filter by app:** Pass `app_id` (from `GET /iga/apps`) to list only entitlements under a specific identity provider app. **Filter by type:** Use the `type` parameter to narrow by entitlement category: - `GROUP` — identity provider group membership (e.g. Azure AD security group, Okta group) - `ROLE` — application role assignment **Filter by status:** Use `status` to filter by publication state: - `PUBLISHED` — available for granting - `DRAFT` — not yet available **Pagination:** Supports `page`, `per_page` (default 25), and `search_key` for name search.

Authentication

X-Api-Keystring

API Key authentication via header

Query parameters

search_keystringOptional>=1 character

Filter entitlements by name (partial match).

app_idlongOptional

Filter entitlements under a specific app (from GET /iga/apps).

typeenumOptional

Filter by entitlement category: GROUP (IDP group membership), ROLE (application role).

Allowed values:

statusenumOptional

Filter by publication state: PUBLISHED (available for granting), DRAFT (not yet available).

Allowed values:

pageintegerOptionalDefaults to 1

Page number (1-indexed). Default 1.

per_pageintegerOptionalDefaults to 25

Results per page (default 25).

Response

Successful response