HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Retrieves the list of all assignments associated with the specified campaign instance from the specific tenant.

get
https://{tenanturl}/v2.0/instances//assignments

The API is used to retrieve the list of all assignments associated with the specified campaign instance from the specific tenant.
The owners of the application can retrieve the list of all assignments associated with the campaign that is created by them or includes at least one application owned by them.
Entitlements required: manageAccessCertification [Manage Access Certification].

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

LoadingLoading

Path Params
string
required

Campaign Instance ID

Query Params
assigneesId
array of strings

The filter for the assignee.

Provide multiple values in new lines or separated by commas. For example, 607000JX53, 6050001F7Z, 50EEPX4TQC

assigneesId
actions
array of strings

The filter for the reviewer action.

Possible values for reviewer actions are: none, approved, rejected, redirected, escalated, noMoreOnTarget.
Provide multiple values in new lines or separated by commas.

actions
reviewersId
array of strings

The filter for the campaign reviewer.

Provide multiple values in new lines or separated by commas. For example, 607000JX53, 6050001F7Z, 50EEPX4TQC

reviewersId
appsId
array of strings

The filter for the campaign application.

Provide multiple values in new lines or separated by commas. For example,7728662622850583652, 7729580475382480456

appsId
assignmentType
array of arrays of strings

The filter for the assignment type: 'role', 'permission', 'account'.

Multiple values can be selected.

assignmentType
assignmentName
array of strings

The filter for the assignment names.
Here, for following campaign types:
userassignment/groupassignment: Provide entitlement name .
groupmembership: provide group name.
account: Provide account userName.

Provide multiple values in new lines or separated by commas.

assignmentName
assignmentStatus
array of arrays of strings

The filter for the assignment value type: 'compliant', 'non_compliant', 'orphan', 'unmanaged', 'unmatched'.

Multiple values can be selected.

assignmentStatus
groupsId
array of strings

The filter for the group Ids.
For following campaign types:
userassignment: The results are filtered based on the discretionary groups .
groupassignment/groupmembership: The results are filtered based on the groups that are attached to the campaign.
Provide multiple values in new lines or separated by commas. For example, 6160015WXY, 6270026WZY, 50FEQX8SRD

groupsId
boolean
Defaults to false

Consider the calling user as a supervisor of the campaign when set to true.

string
Defaults to assigned

Filter campaign assignments based on the source: 'all', 'assigned', 'delegated'.

string

The generic filter for returning campaign assignments that contain the passed string in one of the following attributes: assignee.name, assignee.email, assignee.fullName, assignee.firstName, assignee.lastName, application.name, account.userName, entitlement.name

string

The attribute of the campaign assignment that is used to sort results. The possible values are: application, assignee, accountname, entitlementname, accountstatus, reviewer, lastaction, type, creationdate, groupsid.


When you provide,
application: The application name is used for sorting.
assignee: The assignee fullName is used for sorting.
accountname: The account userName is used for sorting.
entitlementname: The entitlement name is used for sorting.
accountstatus: The account finerStatus is used for sorting.
reviewer: The reviewer name is used for sorting.
lastaction: The last_action is used for sorting.
type: The entitlement type is used for sorting.
creationdate: The campaign assignment creationDate timestamp is used for sorting.
groupsid: The campaign assignment discretionaryGroup name is used for sorting.

boolean
Defaults to true

Decides sort order.

string
Defaults to 500

Specifies the maximum number of resources that the search returns for a page.

string
Defaults to 1

Page number.

Headers
boolean
required

If the value is set to true, the API call is treated as an admin API call.

Responses

500

Your request cannot be processed because an internal server error occurred.

Updated about 1 year ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json

Updated about 1 year ago