Update user roles

PATCH

/domains/{domainID}/users/{userID}/roles

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

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

domainID

required

integer

ID of the domain

userID

required

integer

ID of the user

Header Parameters

X-Csrf-Token

string

CSRF Token

Request Body

Media typeapplication/json

object

roles

List of role IDs the user is associated with

Array<integer>

Example^generated

{
  "roles": [
    1
  ]
}

Responses

200

Role association updated

Media typeapplication/json

object

data

List of role references

Array<object>

object

ID

ID of the role

integer

name

Name of the role

string

Example^generated

{
  "data": [
    {
      "ID": 1,
      "name": "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"
}