Users

Update user access level

Adjust a user's access level within your Account. This lets you promote users to administrators, restrict access for certain team members, or create custom permission sets for specific servers and instances. Any changes you make take effect immediately.

Key Parameters:

  • role: New role to assign to this user (e.g., 'admin', 'full', 'readonly', 'custom').
  • permissions: Object specifying per-resource access levels, required when role is custom. Keys are clouds_<server_ID> / instances_<instance_ID>, values are read (read-only permissions) or write (full permissions).
put/users/{id}

Request

  • Base URL: https://api.cloudpepper.io
  • URL: https://api.cloudpepper.io/users/{id}
  • Auth: HTTP bearer

Request body

role'admin' | 'full' | 'readonly' | 'custom' required

Role to assign to the user

permissionsobject

Custom permissions configuration (required when role is 'custom'). Keys are clouds_<server_ID> or instances_<instance_ID>, values are the access level for that resource.

Example request

{
  "role": "custom",
  "permissions": {
    "clouds_550e8400-e29b-41d4-a716-446655440000": "write",
    "instances_c2e36700-a18f-48bc-9092-d09c335f4fa8": "read"
  }
}

Response

User updated successfully

uidstring

Unique identifier of the updated user

Changes

No recorded changes to this operation across all 1 revision of this API.