Protocol home page
Search...
Support
Studio
Studio
Search...
Navigation
Tenant
Update an Tenant
Documentation
Backend API Reference
Documentation
Community
Blog
Backend API Documentation
Introduction
Tenant
GET
Get Tenant brand properties
PUT
Update Tenant brand properties
GET
Get an Auth Tenant env vars
POST
Rotate Tenant secret key
GET
Get all Tenants
POST
Create Tenant
GET
Get Tenant by public key
GET
[tenants.getBySlug] Get Tenant by slug
GET
Get Tenant by id
PUT
Update Tenant
DEL
Delete Tenant
GET
Get Tenant subscription
GET
Get Tenant members
DEL
Delete Tenant member
PATCH
Update Tenant member
POST
Invite Tenant member
GET
Get Tenant invitations
DEL
Delete Tenant invitation
PATCH
Update Tenant invitation
GET
Get an Tenant
PUT
Update an Tenant
PUT
Update an Tenant's session settings
Domain
GET
Get all Domains
POST
Create Domain
GET
Get Domain by id
DEL
Delete Domain
POST
Verify Domain
POST
Set Domain as primary
Stats
GET
Get recent sign ups
GET
Get recent sign ins
GET
Get sign ups by day
GET
Get sessions by day
GET
Get all dashboard stats
GET
Get uploads by day
GET
Get upload size by day
GET
Get all dashboard stats
GET
Get notifications per day
GET
Get all dashboard stats
GET
Get all content dashboard stats
User
GET
Get all users
POST
Create a user
GET
Get a user
PUT
Update a user
DEL
Delete a user
PUT
Change a user's password
PUT
Suspend a user
PUT
Unsuspend a user
GET
Get all PhoneNumbers for a tenant
GET
Get all User PhoneNumbers
GET
Get a User PhoneNumber
POST
Create a User PhoneNumber
DEL
Delete an PhoneNumber
POST
Make an PhoneNumber the primary PhoneNumber for a User
POST
Verify an PhoneNumber
GET
Get all User EmailAddresses
GET
Get all User EmailAddresses
GET
Get a User EmailAddress
PUT
Update a User EmailAddress
POST
Create a User EmailAddress
DEL
Delete an EmailAddress
POST
Make an EmailAddress the primary EmailAddress for a User
POST
Verify an EmailAddress
GET
Get the current user
GET
List all Tenant Invitations for the current user
POST
Accept a Tenant Invitation
POST
Decline a Tenant Invitation
Organization
GET
Get all organizations
GET
Get an organization
PUT
Update an organization
DEL
Delete an organization
POST
Create an organization
OrganizationMembership
GET
Get all organizationMemberships
GET
Get an organizationMembership
PUT
Update an organizationMembership
DEL
Delete an organizationMembership
POST
Create an organizationMembership
OrganizationInvitation
GET
Get all organizationInvitations
GET
Get an organizationInvitation
PUT
Update an organizationInvitation
DEL
Delete an organizationInvitation
POST
Create an organizationInvitation
AuthRole
GET
Get all authRoles
GET
Get an authRole
PUT
Update a Role
DEL
Delete a Role
POST
Create a Role
Session
GET
Get all sessions
GET
Get all sessions for a user
GET
Get a session
DEL
Delete a session
SocialProvider
GET
Get all SocialProviders
POST
Create an SocialProvider
GET
Get a SocialProvider's secret
GET
Get an SocialProvider
PUT
Update an SocialProvider
DEL
Delete a SocialProvider
JWKCertificate
GET
Get all JWKCertificates
SignInAttempt
GET
Get all signInAttempts
GET
Get a signInAttempt
DEL
Delete a signInAttempt
SignUpAttempt
GET
Get all signUpAttempts
GET
Get a SignUpAttempt
DEL
Delete a SignUpAttempt
Upload
GET
Get all Tenant Uploads
GET
Get a single Upload
DEL
Delete a single Upload
POST
Create a new Upload
Transformation
GET
Get all Tenant Transformations
GET
Get a single Transformation
DEL
Delete a single Transformation
PATCH
Update a single Transformation
POST
Create a new Transformation
File
GET
Get all Tenant Files
GET
Get a single File
DEL
Delete a single File
NotificationTemplate
GET
Get all NotificationTemplates
GET
Get NotificationTemplate by id
PUT
Update NotificationTemplate
DEL
Delete NotificationTemplate
POST
Create NotificationTemplate
GET
Get NotificationTemplate content
PUT
Update NotificationTemplate content
POST
Test NotificationTemplate
POST
Clone all NotificationTemplates to a new tenant
Channel
GET
Get all Channels
GET
Get Channel by id
PUT
Update Channel
DEL
Delete Channel
POST
Create Channel
Notification
POST
Create a Notification
GET
List Email Notifications
GET
List Sms Notifications
GET
List Webhook Notifications
GET
List Push Notifications
GET
List In App Notifications
Schema
GET
Get all Tenant Schemas
GET
Get a single Schema
DEL
Delete a single Schema
PATCH
Update a single Schema
POST
Create a new Schema
Tenant
Update an Tenant
PUT
/
auth
/
tenants
/
{id}
Try it
Path Parameters
​
id
string
required
Body
application/json
​
codeVerificationEmailTemplateId
string | null
​
codeVerificationSMSMessageTemplateId
string | null
​
createOrganizationRedirectUri
string
​
createOrganizationUri
string
​
emailChannelId
string | null
​
emailRequired
boolean
​
emailSignInEnabled
boolean
​
emailVerificationCodeEnabled
boolean
​
emailVerificationLinkEnabled
boolean
​
emailVerificationRequired
boolean
​
frontendApiUri
string
​
homeUri
string
​
logoutRedirectUri
string
​
magicLinkEmailTemplateId
string | null
​
magicLinkSMSMessageTemplateId
string | null
​
nameRequired
boolean
​
organizationAdminDeletingEnabled
boolean
​
organizationAutomaticInvitationEnabled
boolean
​
organizationAutomaticInvitationSuggestionsEnabled
boolean
​
organizationCustomDomainManagementEnabled
boolean
​
organizationMembershipLimit
integer
​
organizationsEnabled
boolean
​
organizationSettingsUri
string
​
passwordRequired
boolean
​
passwordsEnabled
boolean
​
phoneRequired
boolean
​
phoneSignInEnabled
boolean
​
phoneVerificationCodeEnabled
boolean
​
phoneVerificationRequired
boolean
​
sessionInactivityTimeout
integer
​
sessionInactivityTimeoutEnabled
boolean
​
sessionMaximumLifetime
integer
​
sessionMaximumLifetimeEnabled
boolean
​
signInEnabled
boolean
​
signInRedirectUri
string
​
signInUri
string
​
signUpEnabled
boolean
​
signUpRedirectUri
string
​
signUpUri
string
​
smsChannelId
string | null
​
strategyAuthenticatorCodeEnabled
boolean
​
strategyEmailCodeEnabled
boolean
​
strategyEmailLinkEnabled
boolean
​
strategyEmailPasswordEnabled
boolean
​
strategyOAuthEnabled
boolean
​
strategyPhoneCodeEnabled
boolean
​
strategyPhonePasswordEnabled
boolean
​
strategySecurityKeyEnabled
boolean
​
strategyUsernamePasswordEnabled
boolean
​
usernameRequired
boolean
​
usernameSignInEnabled
boolean
​
userSettingsUri
string
​
welcomeEmailTemplateId
string | null
​
welcomeSMSMessageTemplateId
string | null
Response
200 - application/json
Option 1
Option 2
Option 3
The response is of type
any
.
Get an Tenant
Update an Tenant's session settings
