Endpoint
/api/v2/tenants/{tenantId}/roles/search
Path Parameters
tenantId
string

Describes the clientId or mspId of the tenant

Query Parameters
pageNo
integer

pageSize
integer

sortName
string

isDescendingOrder
boolean

Responses

OK

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.defaultRole
results.description
results.name
results.uniqueId
totalPages
integer

totalResults
integer

{
  "descendingOrder": false,
  "nextPage": false,
  "orderBy": "id",
  "pageNo": 1,
  "pageSize": 100,
  "previousPageNo": 0,
  "results": [
    {
      "defaultRole": false,
      "description": "Administrator role for all the service operations supported VAR(s)",
      "name": "Var Administrator",
      "uniqueId": "ROLE-0074b24b-5c0b-2332-dd99-fea506f6cebd"
    },
    {
      "defaultRole": false,
      "description": "Permissions on all Network Devices in SJ Site",
      "name": "Network Administrator",
      "uniqueId": "ROLE-1274b24b-5c0b-2332-dd99-fea506f6cebd"
    },
    {
      "defaultRole": false,
      "description": "Auditor for all Windows and Linux Devices",
      "name": "Auditor Manage",
      "uniqueId": "ROLE-3474b24b-5c0b-2332-dd99-fea506f6cebd"
    },
    {
      "defaultRole": false,
      "description": "Auditor View",
      "name": "Auditor View",
      "uniqueId": "ROLE-5674b24b-5c0b-2332-dd99-fea506f6cebd"
    },
    {
      "defaultRole": true,
      "description": "Partner Administrator",
      "name": "Partner Administrator",
      "uniqueId": "ROLE-7874b24b-5c0b-2332-dd99-fea506f6cebd"
    }
  ],
  "totalPages": 1,
  "totalResults": 5
}