The User object
The User
object describes users within your application. A new User is created when it is submitted with keys
via the API or, if connected and mapped, via third party integrations (e.g. provisioning new users on an existing company). Users may be updated in a similar fashion.
An id
is auto-generated for each User
, but they can also have 1 or many keys
, which serve as unique identifiers that can be referenced via the API or by other systems when creating, retrieving, or updating a User
in Schematic.
Attributes
Unique id
generated by Schematic for the object.
The user’s name, which is displayable to Schematic users.
The Schematic id
associated with the company tied to the user.
Datetime of last update to user data, or last event associated with company. Format is ISO 8601.
Datetime when the user was created. Format is ISO 8601.
Datetime of last update to user data. Format is ISO 8601.
Unique identifier of Schematic environment the user is associated with.
Set of key-value pairs that are associated with the user. This is useful for storing additional information in a structured format that can be queried or used in segmentation, metering, targeting, or filtering.
Set of key-value pairs that represent external, unique identifiers. This is useful for storing external system-generated identifers, for instance from your application, from Stripe, or from Salesforce. Users can be referenced by their id
or any key
via the Schematic API or integration mapping.
Keys must be unique across all users in Schematic.
Set of companies that the user is associated with. Users may be associated with multiple companies.