Change role
PUT
/api/members/{memberId}/roleAdministrator
Path parameters
| Name | Type | Required | Notes |
|---|---|---|---|
memberId | string (uuid) | Required |
Request body
application/json
| Field | Type | Required | Notes |
|---|---|---|---|
role | string | Required | pattern ADMIN|MEMBER |
Response
Success: 200
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Optional | |
email | string | Optional | |
displayName | string | Optional | |
role | enum AppUserRole | Optional | ADMINMEMBER |
createdAt | string (date-time) | Optional |
Errors
| Status | Code | Applies to |
|---|---|---|
400 | validation_faileda field is missing or out of range | Any endpoint |
400 | malformed_requestthe body cannot be read | Any endpoint |
400 | invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUID | Any endpoint |
401 | authentication_requiredno session | Any endpoint |
403 | access_deniedan administrator endpoint, or a missing or stale CSRF token | Any endpoint |
404 | not_foundno such address | Any endpoint |
405 | method_not_allowedthe address does not take that method | Any endpoint |
415 | unsupported_media_typethe address does not read a body of that type | Any endpoint |
500 | internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind it | Any endpoint |
400 | output_language_invalid | Account area |
400 | ui_locale_invalid | Account area |
400 | invitation_invalid | Account area |
400 | organization_slug_invalid | Account area |
404 | invitation_not_found | Account area |
404 | member_not_found | Account area |
409 | email_already_registered | Account area |
409 | invitation_already_pending | Account area |
409 | invitation_email_unavailable | Account area |
409 | organization_slug_taken | Account area |
409 | member_last_administrator | Account area |
Request
bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
# CSRF_HEADER and CSRF_TOKEN are the headerName and token GET /api/csrf returned.
curl -X PUT "http://localhost:8080/api/members/$MEMBER_ID/role" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"role": "<string>"
}'
The request body is an example built from the schema; replace every placeholder.
Response
200Example
{
"id": "<uuid>",
"email": "<string>",
"displayName": "<string>",
"role": "ADMIN",
"createdAt": "<date-time>"
}