HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Search the assignments.

post
https://{tenanturl}/v1.0/entitlements/assignments/search

The API returns the assignment details associated with an entitlement. The assignment can be filtered based on whether the assignment is related to a particular user, a group, or both.
Entitlements required: tenantadmin [Tenant Administrator], manageAppAccessOwner [Manage Application Entitlements], manageEntitlements [Manage Entitlements], readEntitlements [Read Entitlements].

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Query Params
string

The user code to be filtered. The assignment made to this particular user will be filtered.

string

The group code to be filtered. The assignment made to this particular group will be filtered.

string
enum

The assignment type filter [USER, GROUP, DYNAMIC_GROUP]. By default, user, group and dynamic group assignments will be listed. Otherwise assignments will be filtered based on type.

Allowed:
boolean
Defaults to false

Includes rights for each assignment if present.

int32
Defaults to 500

The maximum number of resources for a page. By default, a maximum of 500 resources are returned, if no limit query parameter is passed.
For example, if the limit parameter is set to 25, then, 25 resources are fetched for a page

int32
Defaults to 1

Page number used to get resources for specific page.
Resources are returned for first page if no page query parameter is passed or less than 1 is passed.
For example, if the page parameter is set to 2, then, the resources are fetched for second page.

Body Params

The object filter.

string

Code of the entitlement. Entitlement code is the unique identifier of an entitlement.

string
required

Unique name of the entitlement across the application.

string

Description of the entitlement.

string
enum
required

Specifies the type of the entitlement. Supported values are:
1. role - To create an application role or dynamic role.
2. permission - To create a regular entitlement. Note: the created permission is not provisioned to target application.
Allowable values

Allowed:
string
enum

[Deprecated] Specifies the subtype of the entitlement. Supported values are:
1. regular - (default) If type is specified as permission, then subtype has to be regular. If type is specified as role, then 'regular' subtype indicates an Application Role.
2. dynamic - If type is specified as role, then 'dynamic' subtype indicates a Dynamic Role.
Allowable values

Allowed:
string
required

Application code is the unique identifier of an application. If type is specified as 'permission' or 'role' with subtype as 'regular', then application identifier is necessary.

string

Category of the entitlement.

string

Unique identifier of the mapped object in the connected application.

Responses

500

Your request can't be processed because an internal server error occurred.

Updated 9 months ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json

Updated 9 months ago