Get the capability entitlements for the account

Request

To get the capability entitlements for the logged-in account, send a GET request to:

CODE

https://<host>:<port>/rmg/v1/user/capabilities

Headers

authorization – bearer token that the client received at signon
nv-tenant-id – the tenant ID

Mandatory arguments

None

Other arguments

You can add query parameters for sorting, paging, limiting, and filtering the entitlements that are returned – see the RMG API documentation.

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

If no entitlements were found, the request returns an HTTP 404 status.

Example

A successful request returns a response that looks like this:

HTTP 200 successful response

JS

{
   "totalRecords": 1,
   "resourceSet": [{
      "_id": "6255966d58c418624afd73cf",
      "productId": "de3a572c-2ea8-423a-9659-d8e6d2579add",
      "accountId": "exampleAccount1",
      "status": "SUBSCRIBED",
      "validityType": "ABSOLUTE",
      "productType": "CAPABILITY",
      "validFrom": "2000-02-27T15:33:23Z",
      "expiryDate": "2099-02-27T13:33:23Z",
      "created": "2022-04-12T15:10:37Z",
      "modified": "2022-04-12T15:10:37Z",
      "isArchivable": true,
      "capabilityType": "demo",
      "isFreemium": false,
      "purchasedByDeviceId": "1234"
   }]
}

Here:

productType is always CAPABILITY.
capabilityType indicates the type of capability that the entitlement is for.