Create Entitlement Request

Create Entitlement Request

User request to add/remove entitlements in given organization
(Note: validityToDate will be ignored for mandatory organization roles: org_member, org_owner)

Authorization:

  • org_owner
  • org_member

Access Policy

Role User Accounts
Organization Owner ✔️
Organization Member ✔️
Request
URI
POST
https://{api_host}/csp/gateway//iga/api/orgs/{orgId}/entitlement-requests
COPY
Path Parameters
string
orgId
Required

Organization ID


Request Body
RegisterEntitlements of type(s) application/json
Optional
"RegisterEntitlements Object"
string
requestAction
Optional

Role request type

Possible values are : ADD, REMOVE,
array of string
users
Optional

List of UserId for whom (on behalf-of) entitlements request is raised

array of object
orgRoles
Optional

List of roles

array of object
services
Optional

List of services with requested roles

string
justification
Optional

Business justification for entitlement requests

integer As int64 As int64
roleValidityFromDate
Optional

Date when role should be available from. Date in seconds

integer As int64 As int64
roleValidityToDate
Optional

Date when role should be available till. Date in seconds

Authentication
This operation uses the following authentication methods.
Responses
201

New entitlements request submitted successfully

Returns EntitlementRequestsCreateResponse of type(s) application/json
{
    "requestIds": [
        "1234-5678-9087-XXXXXX",
        "1234-5678-9097-XXXXXX"
    ]
}
array of string
requestIds
Optional

The policy parameter values


400
Operation doesn't return any data structure

401
Operation doesn't return any data structure

403
Operation doesn't return any data structure

404
Operation doesn't return any data structure

500
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/csp/gateway//iga/api/orgs/{orgId}/entitlement-requests