User lifecycle
How users are created
In Authsignal, users are automatically created when you first track an action for them. There’s no separate user creation endpoint - simply start tracking actions with a uniqueuserId
and Authsignal will create the user record.
userId
, Authsignal will:
- Create a new user record automatically
- Associate any provided attributes (email, phone number, etc.) with the user
- Return the action response based on your configured rules
User operations
Get user information
Retrieve detailed information about a user, including their enrollment status and attributes.isEnrolled
- Whether the user has enrolled at least one authentication method- User attributes - Email, phone number, username, display name
- Allowed verification methods - Which authentication methods the user can enroll
- Enrolled verification methods - Which authentication methods the user has enrolled
- Default verification method - The authentication method that will be used for the user’s next action
- Custom - Custom data points to use with rules
Update user attributes
Update user information and attributes. Any fields not provided in the request will remain unchanged.Available user attributes
Attribute | Type | Description |
---|---|---|
email | string | User’s email address |
phoneNumber | string | User’s phone number in E.164 format (e.g., +1234567890) |
username | string | Primary identifier for passkeys (usually email address) |
displayName | string | Display name for passkeys (usually full name) |
custom | object | Custom data points to use with rules |
Custom attributes for rulesThe
custom
field allows you to store additional user data that can be used in Authsignal rules. For example, you might store user tier, account type, or other business-specific attributes.Delete user
Permanently delete a user and all their associated data, including authenticators and action history.User deletion is irreversible and will remove:
- The user record
- All enrolled authenticators
- All action history
- All associated session data
User attributes and data
Contact information
Authsignal stores and manages contact information for authentication purposes:- Email address - Used for email OTP and magic link authentication
- Phone number - Used for SMS/WhatsApp OTP authentication
- Must be in E.164 format (e.g.,
+1234567890
)
Passkey identifiers
For passkey authentication, Authsignal uses specific identifiers:- Username - Primary identifier that uniquely identifies the user.
- Display name - Optional secondary identifier displayed to users to help them recognize the passkey (e.g., the user’s full name).
Custom data for rules
Store additional user attributes in thecustom
field to use with Authsignal rules: