Skip to main content

​
What is a User Identity?

Seam user identities are a feature for tracking and managing user accounts in your application. This feature assigns unique identifiers to each of your users, enabling you to issue and manage their mobile credentials and access permissions. Each user identity is mapped to a user account in your app.

​
User Identities Can Be Connected to Users in Multiple Access Control Systems

User identities can be linked to one ACS user in each access control system. Any mobile credentials issued to these ACS users are consolidated under the user identity. Consequently, a user’s mobile app account has access to these credentials through the user identity.

​
Create a User Identity and Associate it with an ACS User

​
1. Create a User Identity

To create a user identity, you can specify any of the following characteristics:
  • Unique user identity key (user_identity_key)
  • Unique email address (email_address)
  • Unique phone number (phone_number)
  • Full name (full_name)
Note that if you specify one or more of the user_identity_key, email_address, or phone_number, each of these values must be unique within your workspace. Command: 
await seam.userIdentities.create({
  user_identity_key: 'jean_doe',
  email_address: 'jean@example.com',
  phone_number: '+15555550110',
  full_name: 'Jean Doe',
})
Output: 
{
  "user_identity_id": "22222222-2222-2222-2222-222222222222",
  "user_identity_key": "jean_doe",
  "email_address": "jean@example.com",
  "phone_number": "+15555550110",
  "display_name": "Jean Doe",
  "full_name": "Jean Doe",
  ...
}

​
2. Assign an ACS User to the User Identity

To link an ACS user with a user identity, provide the ID of the user identity and the ID of the ACS user. Command: 
const userIdentity = await seam.userIdentities.get({
  email_address: 'jean@example.com',
})

const acsUser = await seam.acs.users.get({
  email_address: 'jean@example.com',
})

await seam.userIdentities.addAcsUser({
  user_identity_id: userIdentity.user_identity_id,
  acs_user_id: acsUser.acs_user_id,
})
Output: 
// void

​
Removing a User Identity

When you delete a user identity, Seam automatically cleans up all other associated resources. Command: 
await seam.userIdentities.delete({
  user_identity_id: '22222222-2222-2222-2222-222222222222',
})
Output: 
// void