Authorizations
Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.
Authentication
Session
User Management
- GETGet Current User Profile
- PATCHUpdate User Profile
- GETGet User's Organization Memberships
- GETGet User's Workspace Memberships
- GETGet User's Email Addresses
- POSTAdd Email Address
- DELRemove Email Address
- POSTPrepare Email Verification
- POSTVerify Email Address
- POSTMake Email Primary
- GETGet User's Phone Numbers
- POSTAdd Phone Number
- DELRemove Phone Number
- POSTSend Phone Verification SMS
- POSTVerify Phone Number with OTP
- POSTSet Phone Number as Primary
- POSTGenerate New TOTP Authenticator
- POSTVerify TOTP Authenticator Setup
- DELDelete TOTP Authenticator
- POSTGenerate Backup Codes
- POSTRegenerate Backup Codes
- POSTUpload Profile Picture
- POSTUpdate Password
- DELRemove Password
- GETGet Active Sessions
- PATCHSign Out from Specific Session
- DELDisconnect Social Connection
- DELDelete User Account
Organizations
- POSTCreate Organization
- DELDelete Organization
- PATCHUpdate Organization
- DELLeave Organization
- GETGet Organization Members
- DELRemove Organization Member
- PUTAdd Member Role
- DELRemove Member Role
- GETGet Organization Invitations
- POSTInvite Member to Organization
- DELCancel Organization Invitation
- GETGet Organization Roles
- POSTCreate Organization Role
- DELDelete Organization Role
- GETGet Organization Domains
- POSTAdd Organization Domain
- POSTVerify Organization Domain
- DELDelete Organization Domain
- GETGet Organization Billing Addresses
- POSTAdd Organization Billing Address
- PUTUpdate Organization Billing Address
- DELDelete Organization Billing Address
Authentication
Check Identifier Availability
Check if an email address or username is available for registration. Returns availability status without creating an account.
POST
/
auth
/
identifier-availability
Copy
curl --request POST \
--url https://{deploymentHost}/auth/identifier-availability \
--header 'Content-Type: application/json' \
--data '{
"email": "[email protected]"
}'Copy
{
"status": 200,
"message": "",
"data": {
"available": true,
"identifier_type": "email",
"identifier": "[email protected]"
},
"session": {
"signin_attempts": [],
"signins": [],
"signup_attempts": [],
"active_signin": null
},
"errors": []
}Previous
Prepare VerificationSend verification code via email or SMS for authentication. Used during signin attempts and profile verification.
Next
⌘I
Copy
curl --request POST \
--url https://{deploymentHost}/auth/identifier-availability \
--header 'Content-Type: application/json' \
--data '{
"email": "[email protected]"
}'Copy
{
"status": 200,
"message": "",
"data": {
"available": true,
"identifier_type": "email",
"identifier": "[email protected]"
},
"session": {
"signin_attempts": [],
"signins": [],
"signup_attempts": [],
"active_signin": null
},
"errors": []
}