Skip Navigation Links

User Groups

List assignable attribute definitionsexperimental

Requires authentication via bearer.

Returns all user attribute definitions that can be used in user group assignment rule conditions. Only TEXT type attributes are supported — other attribute types are filtered out.

Use this endpoint to discover valid attribute_definition_id values before creating or updating assignment rules.

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

Get top attribute values in use with usage statisticsexperimental

Requires authentication via bearer.

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). The endpoint can bee used to identify attribute value candidates when building assignment rule conditions.

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.

Must reference a TEXT type attribute definition.

Query Params

search_term string

Case-insensitive prefix filter for attribute values. Only values starting with this term are returned.

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.

Rule Evaluation Semantics:

  • Multiple rules are combined with logical OR — an assignment is created as soon as any rule matches
  • Within a single rule, multiple conditions are combined with logical AND — all conditions must match
  • An empty rules array means no automated assignment rules are configured for this group

Use the update endpoint to modify the rules for this user group.

Path Params

group_id stringrequired

Unique identifier of a user group.

Query Params

embed string[]

Options for embedding additional data in assignment rule responses:

  • ROLE: Include role reference details (title, description) for each rule
  • ATTRIBUTE_DEFINITION: Include attribute definition reference details (name, technical name) for each condition

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.

Replaces the user group's assignment rules with the provided set of rules. Rules are treated as an atomic value — there is no way to partially update individual rules; the entire rule set is replaced on every call.

Important Behavior:

  • Submitting an empty rules array removes all rules and consequently all rule-based assignments for this group
  • Application of the new rules happens in the background and may take some time
  • All attribute definitions referenced in conditions must exist and must be of type TEXT. Use the assignable attribute definitions endpoint to discover valid attributes.

Path Params

group_id stringrequired

Unique identifier of a user group.

Query Params

embed string[]

Options for embedding additional data in assignment rule responses:

  • ROLE: Include role reference details (title, description) for each rule
  • ATTRIBUTE_DEFINITION: Include attribute definition reference details (name, technical name) for each condition

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