Get Entitlement Requests

List entitlement requests for all users in an org

Authorization:

org_owner

Access Policy

Role	User Accounts
Organization Owner	✔️

Request

URI

GET

https://{api_host}/csp/gateway//iga/api/orgs/{orgId}/entitlement-requests

COPY

Path Parameters

string

orgId

Required

Organization ID

Query Parameters

integer

pageStart

Optional

Constraints: default: 1

Starting page number

integer

pageLimit

Optional

Constraints: default: 15

Page Limit

string

searchTerm

Optional

Search term. The search is done only on the following fields- ticketId, firstName, LastName, email

string

sortField

Optional

Perform sorting on the supported fields

Possible values are : CREATED_ON, UPDATED_ON,

string

sortOrder

Optional

Constraints: default: ASC

Sort order

Possible values are : ASC, DESC,

string of array

status

Optional

The state of the entitlement request. Takes multiple values as specified in the enum

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

List entitlement requests

Returns EntitlementRequests of type(s) application/json

{
    "prevLink": null,
    "nextLink": "/iga/api/orgs/{orgId}/entitlement-requests?pageStart=16&pageLimit=15",
    "totalResults": 500,
    "results": [
        {
            "requestId": "123-456-XXXXXX-XXXXX",
            "ticketId": "1",
            "requestedOn": "123456",
            "requestStatus": "PENDING",
            "requestType": "SELF_REQUEST",
            "roleType": "Organization Role",
            "user": "iga_user:vmware.com:user_1_id",
            "service": "xxsdf-sdsdff-1234-XXXX",
            "role": "orgxxx",
            "justification": "Justification for the request",
            "expiryDate": 123456,
            "requestAction": "ADD"
        },
        {
            "requestId": "123-457-XXXXXX-XXXXX",
            "ticketId": "2",
            "requestedOn": "123456",
            "requestStatus": "PENDING",
            "requestType": "SELF_REQUEST",
            "roleType": "Organization Role",
            "user": "iga_user:vmware.com:user_1_id",
            "service": "xxsdf-sdsdff-1234-XXXX",
            "role": "orgxxx",
            "justification": "Justification for the request",
            "requestAction": "REMOVE"
        }
    ]
}

string

prevLink

Optional

prevLink

string

nextLink

Optional

nextLink

integer

totalResults

Optional

totalResults

array of object

results

Optional

results

400