Get Operator Roles

x-ms-visibility: "important"

Retrieve a paginated list of operator roles.

Query Parameters

page int32

Page number to fetch. Default: 1

limit int32

Number of records per page. Max: 100. Default: 100.

sortKey string

Field to sort by. Default: 'Id'

sortDescending boolean

Set to 'true' to sort in descending order. Default: 'false'

search string

Search for operator roles by name.

Responses

• 200
• 400
• 401
• 500

---

List of operator roles.

application/json

Schema

Example (from schema)

---

Schema

page int32
limit int32
totalRecords int32
hasNextPage boolean
hasPreviousPage boolean
items object[]
Array [
id int64
name string
permissions string[]
Possible values: [SystemAdmin, GlobalAdmin, SiteAdmin, ReadTariffs, WriteTariffs, ReadChargers, WriteChargers, ReadSites, WriteSites, OperateChargers, UpdateChargerFirmware, ReadDrivers, WriteDrivers, ReadSessions, ReadTags, WriteTags, ReadPaymentTerminals, WritePaymentTerminals, ReadIntegrations, WriteIntegrations, ReadBilling, WriteBilling, ReadInvoicing, ReadDLM, WriteDLM, ReadExpress, WriteExpress]
]

{
  "page": 0,
  "limit": 0,
  "totalRecords": 0,
  "hasNextPage": true,
  "hasPreviousPage": true,
  "items": [
    {
      "id": 0,
      "name": "string",
      "permissions": [
        "SystemAdmin"
      ]
    }
  ]
}

Details of the validation error.

application/json

Schema

Example (from schema)

---

Schema

type string
title string
status int32 nullable
detail string
instance string
extensions object
property name* object

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "extensions": {}
}

User is not authorized.

An unexpected error occurred.

application/json

Schema

Example (from schema)

---

Schema

errorCode string
message string
errorNumber int32
helpLink string

{
  "errorCode": "string",
  "message": "string",
  "errorNumber": 0,
  "helpLink": "string"
}

Loading...