OMomni
User attributes

Retrieve switchable values for a user or group

Changed on
<Note> **Organization Admin** permissions are required to use this endpoint. </Note>

Retrieve the values a single user or group can switch a user attribute to.

This endpoint returns only the subject's own provisioning. It does not include values a user inherits from their groups, and it does not reflect the ability of Organization Admin users to switch any attribute to any value.

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

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/user-attributes/{userAttributeId}/selectable-values
  • Auth
    HTTP bearer

Path parameters

userAttributeIdstring uuid required
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

User attribute ID

Query parameters

userIdstring uuid

Organization API key required. The membership ID of the user to act as.

groupIdstring

The user group's mini UUID (short ID), matching the ID returned by the List user groups endpoint. Mutually exclusive with userId.

Response

The subject's provisioned values for this attribute.

Note: A user or group with no provisioned values returns 200 with values: [] and allow_any_value: false.

user_attribute_idstring required

Unique identifier for custom attributes. Empty string for system-defined attributes.

valuesstring[] required

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

allow_any_valueboolean required

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

Example response

{
  "user_attribute_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "values": [
    "acme",
    "globex"
  ]
}

Changes