Get list of available roles

GET

/system/roles

curl --request GET \
  --url https://example.com/api/v1/system/roles \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Parameters

Query Parameters

level

integer

Set detail level of return value. Usually ranges from 0 to 2.

match

string

Match by substring

matchFields

string

Comma separated list of attributes to restrict matching to.

sort

string

/^(ID|name|description)(,(a|de)sc)?$/

Sort by attribute. Can be given multiple times.

ID

Array<integer>

Filter one or more IDs

name

string

Filter by name

description

string

Filter by description

Responses

200

List of roles returned

Media typeapplication/json

object

data

Array<object>

object

ID

Unique ID of the object

integer

name

string

<= 32 characters

description

string

nullable <= 256 characters

permissions

List of permissions associated with the role

Array<object>

object

ID

integer

permission

string

users

List of users associated with the role

Array<object>

object

ID

Unique ID of the object

integer

username

string

Example^generated

{
  "data": [
    {
      "name": "example",
      "description": "example",
      "permissions": [
        {
          "ID": 1,
          "permission": "example"
        }
      ],
      "users": [
        {
          "username": "example"
        }
      ]
    }
  ]
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

The database query failed

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}