Tenant
Update Tenant brand properties
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
Tenant
Update Tenant brand properties
PUT
/
tenants
/
{id}
/
brand
curl --request PUT \
--url https://api.pxyz.dev/api/v0/tenants/{id}/brand \
--header 'Content-Type: application/json' \
--data '{
"background": "<string>",
"foreground": "<string>",
"muted": "<string>",
"mutedForeground": "<string>",
"popover": "<string>",
"popoverForeground": "<string>",
"card": "<string>",
"cardForeground": "<string>",
"border": "<string>",
"input": "<string>",
"primary": "<string>",
"primaryForeground": "<string>",
"secondary": "<string>",
"secondaryForeground": "<string>",
"accent": "<string>",
"accentForeground": "<string>",
"destructive": "<string>",
"destructiveForeground": "<string>",
"ring": "<string>",
"radius": "<string>",
"darkBackground": "<string>",
"darkForeground": "<string>",
"darkMuted": "<string>",
"darkMutedForeground": "<string>",
"darkPopover": "<string>",
"darkPopoverForeground": "<string>",
"darkCard": "<string>",
"darkCardForeground": "<string>",
"darkBorder": "<string>",
"darkInput": "<string>",
"darkPrimary": "<string>",
"darkPrimaryForeground": "<string>",
"darkSecondary": "<string>",
"darkSecondaryForeground": "<string>",
"darkAccent": "<string>",
"darkAccentForeground": "<string>",
"darkDestructive": "<string>",
"darkDestructiveForeground": "<string>",
"darkRing": "<string>",
"darkRadius": "<string>"
}'
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"publicKey": "<string>",
"creatorId": "<string>",
"logoId": "<string>",
"logoUri": "<string>",
"iconId": "<string>",
"iconUri": "<string>",
"auth": {
"id": "<string>",
"tenantId": "<string>",
"signUpEnabled": true,
"signInEnabled": true,
"strategyUsernamePasswordEnabled": true,
"strategyEmailPasswordEnabled": true,
"strategyEmailLinkEnabled": true,
"strategyEmailCodeEnabled": true,
"strategyPhoneCodeEnabled": true,
"strategyPhonePasswordEnabled": true,
"strategyOAuthEnabled": true,
"strategyAuthenticatorCodeEnabled": true,
"strategySecurityKeyEnabled": true,
"passwordsEnabled": true,
"emailSignInEnabled": true,
"phoneSignInEnabled": true,
"usernameSignInEnabled": true,
"nameRequired": true,
"emailRequired": true,
"phoneRequired": true,
"usernameRequired": true,
"passwordRequired": true,
"emailVerificationRequired": true,
"phoneVerificationRequired": true,
"emailVerificationCodeEnabled": true,
"emailVerificationLinkEnabled": true,
"phoneVerificationCodeEnabled": true,
"sessionMaximumLifetimeEnabled": true,
"sessionMaximumLifetime": 123,
"sessionInactivityTimeoutEnabled": true,
"sessionInactivityTimeout": 123,
"homeUri": "<string>",
"frontendApiUri": "<string>",
"signUpUri": "<string>",
"signInRedirectUri": "<string>",
"signInUri": "<string>",
"signUpRedirectUri": "<string>",
"logoutRedirectUri": "<string>",
"userSettingsUri": "<string>",
"organizationSettingsUri": "<string>",
"createOrganizationUri": "<string>",
"createOrganizationRedirectUri": "<string>",
"emailChannelId": "<string>",
"smsChannelId": "<string>",
"codeVerificationEmailTemplateId": "<string>",
"codeVerificationSMSMessageTemplateId": "<string>",
"magicLinkEmailTemplateId": "<string>",
"magicLinkSMSMessageTemplateId": "<string>",
"welcomeEmailTemplateId": "<string>",
"welcomeSMSMessageTemplateId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"brand": "<any>",
"environment": "development",
"domains": [
{
"primary": true,
"name": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
Path Parameters
Body
application/json
Response
200
application/json
Successful response
Available options:
development
, staging
, production
curl --request PUT \
--url https://api.pxyz.dev/api/v0/tenants/{id}/brand \
--header 'Content-Type: application/json' \
--data '{
"background": "<string>",
"foreground": "<string>",
"muted": "<string>",
"mutedForeground": "<string>",
"popover": "<string>",
"popoverForeground": "<string>",
"card": "<string>",
"cardForeground": "<string>",
"border": "<string>",
"input": "<string>",
"primary": "<string>",
"primaryForeground": "<string>",
"secondary": "<string>",
"secondaryForeground": "<string>",
"accent": "<string>",
"accentForeground": "<string>",
"destructive": "<string>",
"destructiveForeground": "<string>",
"ring": "<string>",
"radius": "<string>",
"darkBackground": "<string>",
"darkForeground": "<string>",
"darkMuted": "<string>",
"darkMutedForeground": "<string>",
"darkPopover": "<string>",
"darkPopoverForeground": "<string>",
"darkCard": "<string>",
"darkCardForeground": "<string>",
"darkBorder": "<string>",
"darkInput": "<string>",
"darkPrimary": "<string>",
"darkPrimaryForeground": "<string>",
"darkSecondary": "<string>",
"darkSecondaryForeground": "<string>",
"darkAccent": "<string>",
"darkAccentForeground": "<string>",
"darkDestructive": "<string>",
"darkDestructiveForeground": "<string>",
"darkRing": "<string>",
"darkRadius": "<string>"
}'
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"publicKey": "<string>",
"creatorId": "<string>",
"logoId": "<string>",
"logoUri": "<string>",
"iconId": "<string>",
"iconUri": "<string>",
"auth": {
"id": "<string>",
"tenantId": "<string>",
"signUpEnabled": true,
"signInEnabled": true,
"strategyUsernamePasswordEnabled": true,
"strategyEmailPasswordEnabled": true,
"strategyEmailLinkEnabled": true,
"strategyEmailCodeEnabled": true,
"strategyPhoneCodeEnabled": true,
"strategyPhonePasswordEnabled": true,
"strategyOAuthEnabled": true,
"strategyAuthenticatorCodeEnabled": true,
"strategySecurityKeyEnabled": true,
"passwordsEnabled": true,
"emailSignInEnabled": true,
"phoneSignInEnabled": true,
"usernameSignInEnabled": true,
"nameRequired": true,
"emailRequired": true,
"phoneRequired": true,
"usernameRequired": true,
"passwordRequired": true,
"emailVerificationRequired": true,
"phoneVerificationRequired": true,
"emailVerificationCodeEnabled": true,
"emailVerificationLinkEnabled": true,
"phoneVerificationCodeEnabled": true,
"sessionMaximumLifetimeEnabled": true,
"sessionMaximumLifetime": 123,
"sessionInactivityTimeoutEnabled": true,
"sessionInactivityTimeout": 123,
"homeUri": "<string>",
"frontendApiUri": "<string>",
"signUpUri": "<string>",
"signInRedirectUri": "<string>",
"signInUri": "<string>",
"signUpRedirectUri": "<string>",
"logoutRedirectUri": "<string>",
"userSettingsUri": "<string>",
"organizationSettingsUri": "<string>",
"createOrganizationUri": "<string>",
"createOrganizationRedirectUri": "<string>",
"emailChannelId": "<string>",
"smsChannelId": "<string>",
"codeVerificationEmailTemplateId": "<string>",
"codeVerificationSMSMessageTemplateId": "<string>",
"magicLinkEmailTemplateId": "<string>",
"magicLinkSMSMessageTemplateId": "<string>",
"welcomeEmailTemplateId": "<string>",
"welcomeSMSMessageTemplateId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"brand": "<any>",
"environment": "development",
"domains": [
{
"primary": true,
"name": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}