Skip to main content
PUT

Value requirements

  • Values must be valid for the attribute’s type; for example, a Number attribute rejects acme
  • Requests can contain up to 300 values of up to 512 characters each. For a larger set, use allow_any_value instead.

Removing provisioning

Sending values: [] with allow_any_value: false removes the provisioning entirely. Any switch the user already made no longer applies and they fall back to their assigned value.

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

userAttributeId
string<uuid>
required

User attribute ID

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Body

application/json
user_id
string<uuid>
required

The user's membership ID, not their user ID. Mutually exclusive with group_id.

Example:

"8f14e45f-ceea-467a-9c2b-8f1d2a3b4c5d"

values
string[]
required

Values this user or group can switch the attribute to, validated against the attribute type.

Numbers are sent as strings to preserve precision beyond 2^53. At most 300 values of up to 512 characters each.

Maximum array length: 300
Required string length: 1 - 512
Example:
allow_any_value
boolean

Whether the user can switch to a value that isn't listed.

Example:

false

Response

The provisioning as stored

user_attribute_id
string
required

The user attribute definition this provisioning applies to.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

values
string[]
required

Values this user or group can switch the attribute to. Numbers are returned as strings to preserve precision beyond 2^53.

Maximum array length: 300
Required string length: 1 - 512
Example:
allow_any_value
boolean
required

Whether the user or group can switch to a value that is not listed. When true, selectable_values are suggestions.

Example:

false