User
The basic User schema for the account creation.
1. Basic Properties
Optional domain
Optional domain• domain? : string | DomainSchema
The Domain ID to insert this user into. Optional, if not supplied will default to current domain from the authenticated user calling the endpoint.
email
• email: string
The user email address, should be valid and active. The mediator can require it to be unique depending on the Domain settings.
firstName
• firstName: string
The user first name. This segregation is arbitrary and for
regulatory purposes the sum of the first and last name will be generated.
Validation:
- Min: 2 chars
- Max: 36 chars
lastName
• lastName: string
The user remaining middle names and its last name. This segregation is arbitrary and for
regulatory purposes the sum of the first and last name will be generated.
Validation:
- Min: 2 chars
- Max: 36 chars
Optional password
Optional password• password? : string
The user password for OAuth 2.0 authentication. Optional, if not supplied only the Mediator will be able to operate this account
*Validation:**
- Min: 8 chars
- Max: 36 chars
Optional role
Optional role• role? : UserRole
The main User role in the platform, defined the permissions inherited by this account.
default consumer
2. Consumer Properties
consumer
• consumer: Consumer
The consumer information for Identity Verification and other core features.
Updated almost 4 years ago