Create user attribute
Organization Admin permissions are required to use this endpoint.
Create a custom user attribute definition in your organization.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Body
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.
1"Region"
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_.
1"region"
Data type that determines valid values. String attributes accept text, Number attributes accept numeric values stored as strings for precision. Immutable after creation.
String, Number "String"
Default value applied when no user-specific value is set. A single value when multiple_values is false, an array when it is true.
Strings are trimmed. Number attributes accept numbers or numeric strings and store them as strings. Numbers are converted to strings on receipt; send anything beyond the JSON safe integer range (2^53 - 1) as a string or it loses precision before Omni sees it. Null or a string that trims to empty means no default.
An empty array clears the default of a multi-valued attribute and is rejected for a single-valued attribute. A list member that trims to empty is rejected.
"us-east"
Human-readable description of the attribute and its purpose. An empty string is stored as null.
"User region for row-level security filtering"
Whether the attribute accepts an array of values.
false
Response
User attribute definition created
Default value applied when no user-specific value is set. A single value when multiple_values is false, an array when it is true.
Strings are trimmed. Number attributes accept numbers or numeric strings and store them as strings. Numbers are converted to strings on receipt; send anything beyond the JSON safe integer range (2^53 - 1) as a string or it loses precision before Omni sees it. Null or a string that trims to empty means no default.
An empty array clears the default of a multi-valued attribute and is rejected for a single-valued attribute. A list member that trims to empty is rejected.
"us-east"
Human-readable description of the attribute and its purpose. An empty string is stored as null.
"User region for row-level security filtering"
Unique identifier for custom attributes. Empty string for system-defined attributes.
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
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.
1"Region"
Whether the attribute accepts an array of values.
false
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_.
1"region"
System-defined attributes (e.g. omni_user_id, omni_user_email) are built-in and read-only. Custom attributes have a false value.
false
Data type that determines valid values. String attributes accept text, Number attributes accept numeric values stored as strings for precision. Immutable after creation.
String, Number "String"

