API DocsRESTUser group service

UpdateUserGroup

Updates a user group.

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

Request Body

application/jsonRequired

userGroupobject

updateMask
Required
string

The list of fields to update.

Path Parameters

userGroup.userGroupId
Required
string

curl -X PATCH "<API_URL>/api/v2/user-groups/string" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "userGroup": {
      "name": "string",
      "roleId": "string",
      "isDefault": true,
      "resources": {
        "assetIds": [
          "string"
        ],
        "allAssets": true
      },
      "userIds": [
        "string"
      ]
    },
    "updateMask": "string"
  }'

A successful response.

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