Sign in
User Attributes

Update a user attribute definition

Updates a custom user attribute definition. Omitted fields keep their current values. The type cannot change, and a multi-valued attribute cannot be changed back to a single value. Requires the Manage User Attributes permission.

put/api/v1/user-attributes/{id}

Path parameters

idstring uuid required

User attribute definition ID

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

User attribute definition ID

Request body

descriptionstring nullable

Human-readable description of the attribute and its purpose. An empty string is stored as null.

labelstring

Display name shown in the Omni UI. Unique among the custom attributes in the organization, and may match the label of a system attribute. Must not start with "Omni" and must not be one of the reserved connection labels (Host, Password, Database, Port, Schema, Connection Name).

multiple_valuesboolean

Whether the attribute accepts an array of values.

namestring

Reference name used in model SQL and in embed SSO URL parameters. Unique within the organization. Must start with a letter, contain only letters, numbers and underscores, and must not start with "omni_".

Example request

{
  "description": "User region for row-level security filtering",
  "label": "Region",
  "name": "region"
}

Response

User attribute definition updated

descriptionstring nullable required

Human-readable description of the attribute and its purpose

idstring required

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

labelstring required

Display name shown in the Omni UI

multiple_valuesboolean required

Whether the attribute accepts an array of values. When true, default_value and user-specific values are arrays.

namestring required

Reference name used in model SQL and in embed SSO URL parameters

systemboolean required

System-defined attributes (e.g. omni_user_id, omni_user_email) are built-in and read-only. Custom attributes have system=false.

type'String' | 'Number' required

Data type that determines valid values. String attributes accept text, Number attributes accept numeric values stored as strings for precision.

Example response

{
  "description": "User region for row-level security filtering",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "label": "Region",
  "name": "region",
  "type": "String"
}

Changes

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