Assign or remove a custom role

PUT

/users/{id}/role

Maintainer:Not configured

Assigns a custom role to the user. Pass null for customRoleId to remove the existing role assignment and fall back to the user's default permission resolution.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in header

x-tenant-id

Example:

x-tenant-id: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/users//role' \
--header 'Authorization: Bearer <token>' \
--header 'x-tenant-id: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customRoleId": "5bbd985d-a910-4d1b-849b-dfb76da59ba8"
}'

Response Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "firstName": "string",
    "lastName": "string",
    "email": "user@example.com",
    "countryCode": "string",
    "mobileNumber": "string",
    "role": "PLATFORM_ADMIN",
    "active": true,
    "builderId": "4b6f0f50-c3ff-41b4-b331-cde5320182e5",
    "builderName": "string",
    "projectAccessDescription": "string",
    "projectAccess": [
        {
            "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
            "projectName": "string",
            "accessType": "FULL_PROJECT_ACCESS",
            "towerIds": [
                "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ],
            "towerNames": [
                "string"
            ]
        }
    ],
    "customRoleId": "5bbd985d-a910-4d1b-849b-dfb76da59ba8",
    "customRoleName": "string",
    "permissions": {
        "property1": [
            "string"
        ],
        "property2": [
            "string"
        ]
    },
    "verified": true
}

Modified at 2026-04-16 18:43:47

Toggle user status

List all users (paginated)