Operations with Specific UserBundle
Resource | /api/admin/customFieldSettings/bundles/user/{bundleID} |
Returned entity | UserBundle. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
UserBundle attributes
Represents a bundle that contains users. You can add to the bundle individual user accounts, as well as group of users.
Extends Bundle
This table describes attributes of the UserBundle entity.
To receive an attribute in the response from server, specify it explicitly in the request parameter
fields.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
groups | Array of UserGroups | User groups that belong to this bundle. |
individuals | Array of Users | Individual users that belong to this bundle. |
aggregatedUsers | Array of Users | All users that belong to this bundle. |
Read a Specific UserBundle
Request syntax
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | string | A list of UserBundle attributes that should be returned in the response. If no field is specified, only the |
Update a Specific UserBundle
Request syntax
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | string | A list of UserBundle attributes that should be returned in the response. If no field is specified, only the |
Delete a Specific UserBundle
Request syntax
Request parameters
Parameter | Type | Description |
|---|