Skip to main content
PATCH
Update a user role

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

id
string
required

UserRole identifier

Body

application/merge-patch+json

The updated UserRole resource

role
string<iri-reference> | null
Example:

"/api/v1/roles/1"

user
string<iri-reference>
Example:

"/api/v1/users/1"

unit
string<iri-reference> | null
Example:

"/api/v1/units/1"

dateCreated
string<date-time>
dateEnded
string<date-time> | null
isAdmin
boolean | null
localCenterPermission
string | null
import
string<iri-reference> | null
Example:

"/api/v1/imports/1"

Response

UserRole resource updated

id
integer
read-only
role
object | null
user
object
unit
string<iri-reference> | null
Example:

"/api/v1/units/1"

dateCreated
string<date-time>
dateEnded
string<date-time> | null
isAdmin
boolean | null
localCenterPermission
string | null