User Group
The User Group object represents a user group in the Marketplace platform. This object contains the following properties:
id
string
The primary identifier for the user group.
Example: UGR-1234-1234
href
string
A relative reference to the object within the API.
Example: /v1/accounts/groups/UGR-1234-1234
icon
string
The relative path to the token’s logo.
Example: /static/accounts/UGR-1234-1234/logo.png
name
string
The name of the user group.
Example: Stark Industries
description
string
A description of the group.
Example: Stark's marketing group
default
bool
Indicates if the user group is set as default within the account. There can be only one default user group per account.
Example: true
stats
stats
Statistics for the group. A group can be deleted only if the user count is 0.
Example:
{
"users": 123
}
Example
{
"id": "UGR-5116-6265",
"name": "Test-1",
"description": "Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium.",
"modules": [
{
"id": "MOD-1756-1452",
"name": "Access management"
},
{
"id": "MOD-9042-8216",
"name": "Account management"
}
],
"icon": "https://picsum.photos/210/201",
"default": true,
"stats": {
"users": 123
}
}
Last updated
Was this helpful?