Entitlement

API to interact with entitlements

An Entitlement is configured by Organization Admins to publish Catalog Items, Services and Resource Actions to Consumers within their organization. The entitled Catalog Items must be owned by the publishing Organization or alternatively they must have been published to the publishing organization first through an organization entitlement.

The following resources are applicable:

/api/entitlements

GET

Get Entitlements that belongs to a particular tenant or user. If the user Id is specified in the request then the entitlements for the user are returned otherwise the entitlements for the tenant are returned.

Permissions

Solution Provider System Admin Tenant Manager User Permissions
CATALOG_AUTHOR_TENANT CATALOG_AUTHOR_SUBTENANT CATALOG_ENTITLE_SUBTENANT CATALOG_ENTITLE_TENANT

Parameters

name description type default
page Page Number query 1
limit Number of entries per page query 20
$orderby Multiple comma-separated properties sorted in ascending or descending order query
$top Sets the number of returned entries from the top of the response (total number per page in relation to skip) query
$skip Sets how many entries you would like to skip query
$filter Boolean expression for whether a particular entry should be included in the response query
userId The user's Id. This is an optional parameter. query

Response Body

element: Page of entitlement
media types:

Entitlements by tenant or userId (if it is specified).

POST

Create an Entitlement.This will check the existence of the Entitlement and validate its fields according to business rules.For e.g.it validates that an organization is specified for the entitlement.

Permissions

Solution Provider System Admin Tenant Manager User Permissions
CATALOG_ENTITLE_SUBTENANT CATALOG_ENTITLE_TENANT

Request Body

element: entitlement
media types:

The Entitlement to create.

Response Body

element: entitlement
media types:

The entitlement that got created in the system. It has the unique identifier associated with it.

Status Codes

HTTP Status Code Description
201 Created Created

/api/entitlements/{entitlementId}

PUT

Update a Entitlement upon the existence and validation of Entitlement.

Permissions

Solution Provider System Admin Tenant Manager User Permissions
CATALOG_ENTITLE_SUBTENANT CATALOG_ENTITLE_TENANT

Parameters

name description type default
entitlementId UUID of the Entitlement to be updated path

Request Body

element: entitlement
media types:

The Entitlement to be updated

Status Codes

HTTP Status Code Description
204 No Content No Content

/api/entitlements/{id}

GET

Gets an Entitlement corresponding to its unique Id.

Permissions

Solution Provider System Admin Tenant Manager User Permissions
CATALOG_AUTHOR_TENANT CATALOG_AUTHOR_SUBTENANT CATALOG_ENTITLE_SUBTENANT CATALOG_ENTITLE_TENANT

Parameters

name description type default
id The uuid of an Entitlement. path

Response Body

element: entitlement
media types:

Entitlement corresponding to its unique Id.

/api/entitlements/order

POST

Update the order of existing entitlements for a Tenant.

Permissions

Solution Provider System Admin Tenant Manager User Permissions
CATALOG_ENTITLE_SUBTENANT CATALOG_ENTITLE_TENANT

Parameters

name description type default
subtenantId The subtenant Id of the subtenant that the entitlement is a part of. query

Request Body

element: multipleLiteral
media types:

a MultipleLiteral comprising a list of String literals which are Entitlement IDs. The order of IDs in the list defines the new priorityOrder value for each entitlement.

Status Codes

HTTP Status Code Description
204 No Content No Content