iotoms Docs

Get a role

GET
/api/v1/management/roles/{id}

Returns one user role by its ID: name, role key, status and when it was last changed. Use Get features assigned to a role for its permissions.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*integer

ID of the record.

Formatint64

Response Body

OK

*/*
  1. response
id?|

Role ID. Set by the server.

Formatint64
name*string

Role name, unique across the merchant. Required.

roleKey*string

Stable key for the role, e.g. CASHIER. Upper-cased with spaces turned to underscores; built from the name when left blank.

status*string

Role status text. Defaults to active.

modifiedTime*string

When the role was last changed. Set by the server.

Formatdate-time
Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/management/roles/0'
Example Response
{  "id": 0,  "name": "string",  "roleKey": "string",  "status": "string",  "modifiedTime": "2019-08-24T14:15:22Z"}