UpdateUserGroup

Updates a user group.

PATCH /api/v2/user-groups/{userGroup.userGroupId}

UpdateUserGroup

cURL

curl --request PATCH \
  --url https://api.siftstack.com/api/v2/user-groups/{userGroup.userGroupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updateMask": "<string>",
  "userGroup": {
    "name": "<string>",
    "roleId": "<string>",
    "isDefault": true,
    "userIds": [
      "<string>"
    ],
    "isExternal": true
  }
}
'

200

{
  "userGroup": {
    "name": "<string>",
    "isDefault": true,
    "isExternal": true,
    "userGroupId": "<string>",
    "roleId": "<string>",
    "resources": {
      "allAssets": true,
      "assetIds": [
        "<string>"
      ]
    },
    "userIds": [
      "<string>"
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userGroup.userGroupId · string · required

Body

application/json

updateMask · string · required

The list of fields to update.

userGroup · object

Show child attributes

Response

200

application/json

A successful response.

userGroup · object · required

Show child attributes