User Bundles

Resource	/api/admin/customFieldSettings/bundles/user
Returned entity	UserBundle. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a List of UserBundles. `POST`: Add a New UserBundle.
Supported sub-resources	/api/admin/customFieldSettings/bundles/user/{bundleID}: Operations with Specific UserBundle /api/admin/customFieldSettings/bundles/user/{bundleID}/groups: User Groups /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals: Users /api/admin/customFieldSettings/bundles/user/{bundleID}/aggregatedUsers: Users

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-only`.

GET /api/admin/customFieldSettings/bundles/user?{fields}&{$top}&{$skip}

Parameter	Type	Description
fields	string	A list of UserBundle attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.
$skip	int	Optional. Lets you set a number of returned entities to skip before returning the first one.
$top	int	Optional. Lets you specify the maximum number of entries that are returned in the response.

POST /api/admin/customFieldSettings/bundles/user?{fields}

Parameter	Type	Description
fields	string	A list of UserBundle attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.

Last modified: 8 July 2019