Sign in
User Attributes

Read switchable values for a user or group

Returns the values a single user or group may switch this attribute to. Exactly one of userId or groupId is required. A subject with no provisioning returns empty values and allow_any_value false.

get/api/v1/user-attributes/{userAttributeId}/selectable-values

Path parameters

userAttributeIdstring uuid required

The user attribute definition id

Query parameters

groupIdstring uuid

User group id. Mutually exclusive with userId.

User group id. Mutually exclusive with userId.

userIdstring uuid

Target user membership id (not a user id). Mutually exclusive with groupId.

Target user membership id (not a user id). Mutually exclusive with groupId.

Response

The subject's provisioning for this attribute

allow_any_valueboolean required

Additionally allow any value at all, typed or picked, held only to the attribute type. The values currently assigned to anyone in the organization are offered as suggestions, resolved at read time.

user_attribute_idstring uuid required

The attribute definition this provisioning applies to

valuesstring[] required

Values this subject may switch the attribute to. Validated against the attribute type: a Number attribute rejects non-numeric entries. Numbers are carried as strings to preserve precision beyond 2^53. At most 300 values, each up to 512 characters; a larger set should use allow_any_value.

Example response

{
  "values": [
    "acme",
    "globex"
  ]
}

Changes

Changed in 1 of the 46 revisions of this API.1