Replace user's group permissions

The PUT /users/{userId}/permissions/groups endpoint replaces the user’s group permissions for the user matching the user ID provided.

Request parameters

Query parameters

The endpoint accepts the following query parameters:

userID

The user ID of the required user.

Request body parameters

The endpoint requires a groupPermissions object in JSON format as in the request body.

Example request body

{
  "groupPermissions": [
    {
      "groupId": "1d75b21f-6d94-4477-9ba7-513a30bfc21d",
      "groupPermission": "Write"
    },
    {
      "groupId": "fd6e3099-8673-4b11-865b-2e15ec80911a",
      "groupPermission": "Read"
    }
  ]
}

where:

• groupPermissions. The user’s group permissions.
  
  • groupId. The unique ID of the group that the user has access to.
    
  • groupDisplayID. The unique ID of the group that the user has access to.
  • groupName. The name of the group that the user has access to.
  • groupPermission. Access levels for accessing resources such as groups. Possible values: None, Read, Write.

Responses

Successful response

Successful requests return a 200 Success code.