Get User Attribute Group Values

Version 4.0.24.14

Returns all values of a user attribute defined by user groups, in precedence order.

A user may be a member of multiple groups which define different values for a given user attribute. The order of group-values in the response determines precedence for selecting which group-value applies to a given user. For more information, see Set User Attribute Group Values.

Results will only include groups that the caller's user account has permission to see.

Request

GET /user_attributes/{user_attribute_id}/group_values
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
user_attribute_id
string
Id of user attribute
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields.

Response

200: All group values for attribute.

Datatype
Description
can
object
Operations the current user is able to perform on this object
id
string
Unique Id of this group-attribute relation
group_id
string
Id of group
user_attribute_id
string
Id of user attribute
value_is_hidden
boolean
If true, the "value" field will be null, because the attribute settings block access to this value
rank
integer
Precedence for resolving value for user
value
string
Value of user attribute for group

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link