User Groups

Returns attribute values that are currently assigned to users along with usage counts. Results are sorted by usage count in descending order (most used values first). Supports case-insensitive prefix search via the search_term parameter.

Path Params

definition_id stringrequired

The ID of the attribute definition to retrieve values for

Query Params

search_term string

A term that needs a starts-with match with attribute values (case insensitive).

limit integer

Maximum number of attribute values to return

Response Body

200 OK

Get user group assignment rulesexperimental

Requires authentication via bearer.

Returns the user group's current rules for automated assignments.

Path Params

group_id stringrequired

Unique identifier of a user group.

Query Params

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

Update user group assignment rulesexperimental

Requires authentication via bearer.

Updates the rules used to generate automated assignments. Application of the new rules happens in the background and may take some time.

Path Params

group_id stringrequired

Unique identifier of a user group.

Query Params

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Request Body

rules object[]

A single rule to create assignments with the specified role based on a list of conditions. Multiple conditions are concatenated via a logical and.

Response Body

200 OK