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
Deployment
Get Deployment Information
Retrieve deployment configuration and settings. Requires authentication to access detailed deployment data.
GET
/
deployment
Get Deployment Information
Copy
curl --request GET \
--url https://{deploymentHost}/deploymentCopy
{
"status": 200,
"message": "",
"data": {
"id": 123,
"name": "Acme Corp Production",
"hostname": "auth.acme.com",
"environment": "production",
"features": {
"oauth_google": true,
"oauth_github": true,
"oauth_microsoft": false,
"phone_verification": true,
"magic_links": true,
"two_factor_auth": true
},
"ui_settings": {
"app_name": "Acme Corp Authentication",
"logo_image_url": "https://cdn.acme.com/logo.svg",
"primary_color": "#2563eb",
"background_color": "#ffffff"
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
"session": {
"signin_attempts": [],
"signins": [
{
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"errors": []
}Previous
Sign InAuthenticate users with multiple strategies including email/password, username/password, phone OTP, email OTP, magic links, and social sign-on.
Next
⌘I
Get Deployment Information
Copy
curl --request GET \
--url https://{deploymentHost}/deploymentCopy
{
"status": 200,
"message": "",
"data": {
"id": 123,
"name": "Acme Corp Production",
"hostname": "auth.acme.com",
"environment": "production",
"features": {
"oauth_google": true,
"oauth_github": true,
"oauth_microsoft": false,
"phone_verification": true,
"magic_links": true,
"two_factor_auth": true
},
"ui_settings": {
"app_name": "Acme Corp Authentication",
"logo_image_url": "https://cdn.acme.com/logo.svg",
"primary_color": "#2563eb",
"background_color": "#ffffff"
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
"session": {
"signin_attempts": [],
"signins": [
{
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
],
"signup_attempts": [],
"active_signin": {
"id": "signin_987654321",
"user_id": "user_456789123",
"created_at": "2024-01-01T12:00:00Z"
}
},
"errors": []
}