Skip to main content
PATCH
/
tenant
Update Tenant
curl --request PATCH \
  --url https://api.authsignal.com/v1/management/tenant \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "disableRecoveryCodes": true,
  "tokenDurationInMinutes": 123
}'
{
  "tenantId": "<string>",
  "allowDisablingMfa": true,
  "hideAuthsignalLogo": true,
  "customDomain": "<string>",
  "redirectOnSessionExpiry": true,
  "allowDeletingUserAuthenticators": true,
  "disableRecoveryCodes": true,
  "skipRecoveryCodesOnProgrammaticEnrollment": true,
  "hideRecoveryCodesOnEnrollment": true,
  "tokenDurationInMinutes": 123
}

Authorizations

Authorization
string
header
required

Use your Authsignal Management API secret key as the username and leave the password empty. This key is different from the Server API key and can be found in the API Keys section of the Authsignal Portal settings page.

Body

application/json
name
string

The name of the tenant.

disableRecoveryCodes
boolean

Whether to disable recovery codes as an authentication method.

tokenDurationInMinutes
number

The duration in minutes for which an Authsignal challenge token is valid. This determines the expiry of an Authsignal challenge and the duration of the pre-built UI session.

Response

OK

tenantId
string
allowDisablingMfa
boolean
customDomain
string
redirectOnSessionExpiry
boolean
allowDeletingUserAuthenticators
boolean
disableRecoveryCodes
boolean
skipRecoveryCodesOnProgrammaticEnrollment
boolean
hideRecoveryCodesOnEnrollment
boolean
tokenDurationInMinutes
number