User
Create a user
Backend API Documentation
Tenant
- GETGet Tenant brand properties
- PUTUpdate Tenant brand properties
- GETGet an Auth Tenant env vars
- POSTRotate Tenant secret key
- GETGet all Tenants
- POSTCreate Tenant
- GETGet Tenant by public key
- GET[tenants.getBySlug] Get Tenant by slug
- GETGet Tenant by id
- PUTUpdate Tenant
- DELDelete Tenant
- GETGet Tenant subscription
- GETGet Tenant members
- DELDelete Tenant member
- PATCHUpdate Tenant member
- POSTInvite Tenant member
- GETGet Tenant invitations
- DELDelete Tenant invitation
- PATCHUpdate Tenant invitation
- GETGet an Tenant
- PUTUpdate an Tenant
- PUTUpdate an Tenant's session settings
Domain
Stats
User
- GETGet all users
- POSTCreate a user
- GETGet a user
- PUTUpdate a user
- DELDelete a user
- PUTChange a user's password
- PUTSuspend a user
- PUTUnsuspend a user
- GETGet all PhoneNumbers for a tenant
- GETGet all User PhoneNumbers
- GETGet a User PhoneNumber
- POSTCreate a User PhoneNumber
- DELDelete an PhoneNumber
- POSTMake an PhoneNumber the primary PhoneNumber for a User
- POSTVerify an PhoneNumber
- GETGet all User EmailAddresses
- GETGet all User EmailAddresses
- GETGet a User EmailAddress
- PUTUpdate a User EmailAddress
- POSTCreate a User EmailAddress
- DELDelete an EmailAddress
- POSTMake an EmailAddress the primary EmailAddress for a User
- POSTVerify an EmailAddress
- GETGet the current user
- GETList all Tenant Invitations for the current user
- POSTAccept a Tenant Invitation
- POSTDecline a Tenant Invitation
Organization
OrganizationMembership
OrganizationInvitation
SocialProvider
JWKCertificate
Upload
Transformation
NotificationTemplate
- GETGet all NotificationTemplates
- GETGet NotificationTemplate by id
- PUTUpdate NotificationTemplate
- DELDelete NotificationTemplate
- POSTCreate NotificationTemplate
- GETGet NotificationTemplate content
- PUTUpdate NotificationTemplate content
- POSTTest NotificationTemplate
- POSTClone all NotificationTemplates to a new tenant
Notification
User
Create a user
POST
/
auth
/
users
object
*
tenantId
string
*
tenantId
Required
string
name
string
name
string
email
string
email
string
username
string
username
string
roleId
string
roleId
string
phone
string
phone
string
password
string
password
string
publicMeta
string
publicMeta
string
privateMeta
string
privateMeta
string
Body
application/json
tenantId
string
requiredname
string
email
string
username
string
roleId
string
phone
string
password
string
publicMeta
any
privateMeta
any
Response
200 - application/json
id
string
requiredtenantId
string
requiredname
string | null
requiredemailAddresses
object[]
requiredphoneNumbers
object[]
requiredcreatedAt
string
requiredupdatedAt
string
requiredimageUri
string | null
lastSignInAt
string | null
lastActiveAt
string | null
username
string | null
status
enum<string> | null
Available options:
active
, inactive
, suspended
roleId
string | null
role
object | null
primaryEmailId
string | null
primaryPhoneId
string | null
publicMeta
any | null
privateMeta
any | null