API DocsRESTUser group service

GetUserGroup

Retrieves a user group.

GET
/api/v2/user-groups/{userGroupId}

Path Parameters

userGroupId
Required
string

curl -X GET "<API_URL>/api/v2/user-groups/string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

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

Previous

DeleteUserGroup DELETE

Next

GetUserGroupsForAssets GET