Sign in
Roles

Update a Role

Update an existing role

patch/roles/{id}

Path parameters

idstring required
Example:8cbb43fe-4cdf-4991-8352-c461779cec02

Unique identifier for the object.

Query parameters

fieldsstring[]

Control what fields are being returned in the object.

metastring

What metadata to return in the response.

Request body

descriptionstring

Description of the role.

enforce_tfaboolean

Whether or not this role enforces the use of 2FA.

external_idstring

ID used with external services in SCIM.

ip_accessstring[]

Array of IP addresses that are allowed to connect to the API as a user of this role.

module_listingstring

Custom override for the admin app module bar navigation.

namestring

Name of the role.

Response

Successful request

Example response

{
  "data": {
    "id": "2f24211d-d928-469a-aea3-3c8f53d4e426",
    "name": "Administrator",
    "icon": "verified_user",
    "description": "Admins have access to all managed data within the system by default",
    "users": [
      {
        "id": "63716273-0f29-4648-8a2a-2af2948f6f78",
        "first_name": "Admin",
        "last_name": "User",
        "email": "admin@example.com",
        "avatar": {
          "id": "8cbb43fe-4cdf-4991-8352-c461779cec02",
          "storage": "local",
          "filename_disk": "a88c3b72-ac58-5436-a4ec-b2858531333a.jpg",
          "filename_download": "avatar.jpg",
          "title": "User Avatar",
          "type": "image/jpeg",
          "folder": {
            "id": "0cf0e03d-4364-45df-b77b-ca61f61869d2",
            "name": "New York"
          },
          "created_on": "2019-12-03T00:10:15+00:00",
          "charset": "binary",
          "filesize": 137862,
          "width": 800,
          "height": 838,
          "uploaded_on": "2019-12-03T00:10:15+00:00"
        },
        "language": "en-US",
        "status": "active",
        "last_access": "2020-05-31T14:32:37Z",
        "last_page": "/my-project/settings/collections/a"
      }
    ]
  }
}

Changes