Update a role

PATCH

/system/roles/{ID}

curl --request PATCH \
  --url https://example.com/api/v1/system/roles/1 \
  --header 'Content-Type: application/json' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt> \
  --data '{ "name": "example", "description": "example", "permissions": [ { "ID": 1, "permission": "example" } ], "users": [ 1 ] }'

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

ID

required

integer

ID of the object

Header Parameters

X-Csrf-Token

string

CSRF Token

Request Body

Media typeapplication/json

object

name

string

description

string

nullable

permissions

Array<object>

object

ID

integer

permission

string

users

List of user IDs to associate with the role

Array<integer>

Example^generated

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

Responses

200

Role updated

Media typeapplication/json

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

{
  "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"
  ]
}

404

The requested resource could not be found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "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"
}