UserIdentities
Represents the identities associated with users, such as email addresses, phone numbers, and social accounts.
Table-Specific Information
Select
The following queries are processed server-side while other filters are processed client-side within the provider.SELECT * FROM UserIdentities WHERE UserId = '123'
SELECT * FROM UserIdentities WHERE UserId = '123' AND Id = '345'
Insert
The Type, Value, and UserId columns are required to insert. This operation is allowed for logged-in users with the "agent" role.
INSERT INTO UserIdentities (Type, Value, UserId) VALUES ('email', '[email protected]', '123')
Update
You must specify the Id of the identity and UserId to update. This operation is allowed for logged-in users with the "agent" role.Update allows you to do the following:
- Set the specified identity as verified. Note that you cannot unverify a verified identity. Note: Primary should be true.
UPDATE UserIdentities SET Verified = true WHERE UserId = '123' AND Id = '456'
- Update the value of the specified identity:
UPDATE UserIdentities SET Value = '[email protected]' WHERE UserId = '123' AND Id = '456'
Delete
You must specify the Id and UserId of the identity to delete a user identity. Users must have at least one identity after deletion. This operation is allowed for logged-in users with the "agent" role.
DELETE FROM UserIdentities WHERE UserId = '123' AND Id = '456'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The Id of the user identity, automatically assigned on creation. | |
| UserId [KEY] | Long | True |
Users.Id |
The Id of the user. |
| Type | String | False |
One of email, twitter, facebook, google, or phone_number. | |
| Value | String | False |
The identifier for this identity, such as an email address. | |
| Verified | Boolean | False |
Indicates whether the identity has been verified. | |
| Primary | Boolean | False |
Indicates whether this is the user's primary identity. Writable only when creating, not when updating. | |
| CreatedAt | Datetime | True |
The date and time when the user identity was created. | |
| UpdatedAt | Datetime | True |
The date and time when the user identity was last updated. | |
| UndeliverableCount | Integer | True |
The number of times an email was undeliverable. | |
| DeliverableState | String | True |
The deliverable state of the identity. | |
| Url | String | True |
The URL of this resource. |