Sign in
User Attributes

Set switchable values for a user or group

Replaces the values a user or group may switch this attribute to. Values are validated against the attribute type. Sending an empty values array with allow_any_value false removes the provisioning entirely, which also stops honouring any switch the user has already made.

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

Path parameters

userAttributeIdstring uuid required

The user attribute definition id

Request body

OR

Example request

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

Response

The provisioning as stored

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