Skip to content
Developers
No results found.

Update Tenant Settings

Scopes
write:tenant

Path Parameters

tenant_id
string
Required

Tenant identifier

Request Body

acr_values
array<string>
api_version
string

Available Values: 2021-07-04

auto_sign_in
boolean
default_strategy
string
expose_unsafe_errors
boolean
extra_params
array<string>
extra_scopes
array<string>
force_email_verification
boolean
forgot_password_enabled
boolean
hash_function
string

Available Values: bcryptargon2

Default Value: "bcrypt"

register_enabled
boolean
tenant_login_url
string
welcome_emails_enabled
boolean
authenticator
object

PlusAuth Authenticator Application related settings

authenticator.
bind_sim
boolean

Should authenticator application logout if a SIM card change detected on device

ciba
object
ciba.
delivery_mode
string

Available Values: pingpoll

ciba.
notifier_endpoint
string
environment_variables
object
policies
object
policies.
account_blocking
object
policies.account_blocking.
allow_user_unblock
boolean

If true, users will be able to unblock their accounts by the link received in notification email.

Default Value: true

policies.account_blocking.
allowed_attempts
integer
min5
max
250

Maximum failed login attempts to block user for specified duration.

Default Value: 10

policies.account_blocking.
block_duration
integer
min60
max
630720000

Number of seconds to block the account.

Default Value: 630720000

policies.account_blocking.
duration
integer
min60
max
7776000

Number of seconds before attempts are reset

Default Value: 7776000

policies.account_blocking.
enabled
boolean

Default Value: true

policies.account_blocking.
notification
boolean

Send an email to user's email address about the activity.

Default Value: true

policies.account_blocking.
reset_after_success
boolean

Reset failed attempts count after successful login.

policies.
brute_force
object
policies.brute_force.
allowed_attempts
integer
min5
max
50

Allowed consecutive login attempts

Default Value: 10

policies.brute_force.
block_duration
integer
min60
max
630720000

Number of seconds to block the IP.

Default Value: 630720000

policies.brute_force.
duration
integer
min60
max
7776000

Number of seconds before attempts are reset

Default Value: 7776000

policies.brute_force.
enabled
boolean

Default Value: true

policies.brute_force.
notification
boolean

Send an email to user's email address about the activity.

Default Value: true

policies.brute_force.
white_list
array<string>

Whitelisted IP addresses.

policies.
password
object

Password policy settings to be enforced to your new users.

policies.password.
custom_chars
string
length
1-64

Require at least on of the given characters

policies.password.
history
integer
min1
max
10

The system will maintain a password history for each user and prevent the reuse of passwords included in the history. The password history can be up to 10 in size. When provided, the system will maintain existing and new users' password history going forward.

policies.password.
lower_case
integer
min0
max
32

Require at least given value of lowercase letters

policies.password.
max
integer
max
128

Maximum number of characters

policies.password.
min
integer
min0

Minimum number of characters

policies.password.
number
integer
min0
max
32

Require at least given value of numbers

policies.password.
upper_case
integer
min0
max
32

Require at least given value of uppercase letters

ttl
object

Lifetime settings of generated tokens defined in seconds.

ttl.
access_token
integer
min30
max
2592000
ttl.
authorization_code
integer
min30
max
86400
ttl.
backchannel_authentication_request
integer
min30
max
86400
ttl.
client_credentials
integer
min30
max
2592000
ttl.
device_code
integer
min30
max
86400
ttl.
id_token
integer
min30
max
31536000
ttl.
refresh_token
integer
min300
max
15552000
ttl.
session
integer
min600
max
15552000
user_self_deletion
object
user_self_deletion.
enabled
boolean

Allow end-users to delete their accounts. This enables the delete-account prompt which you can request to allow users delete their accounts.

PATCH
/tenants/{tenant_id}/settings
cURL
cURLC#DartGoJavaJavaScriptPHPPythonRubyRustSwift
1
2
3
4
5
Loading...
Response
200
200
Loading...

Response Body Schema

acr_values
array<string>
Required
auto_sign_in
boolean
Required
expose_unsafe_errors
boolean
Required
extra_params
array<string>
Required
extra_scopes
array<string>
Required
force_email_verification
boolean
Required
forgot_password_enabled
boolean
Required
hash_function
string
Required

Available Values: bcryptargon2

Default Value: "bcrypt"

register_enabled
boolean
Required
tenant_login_url
string
Required
welcome_emails_enabled
boolean
Required
api_version
string

Available Values: 2021-07-04

default_strategy
string
authenticator
object
Required

PlusAuth Authenticator Application related settings

authenticator.
bind_sim
boolean
Required

Should authenticator application logout if a SIM card change detected on device

ciba
object
Required
ciba.
delivery_mode
string
Required

Available Values: pingpoll

ciba.
notifier_endpoint
string
Required
environment_variables
object
Required
policies
object
Required
policies.
account_blocking
object
Required
policies.account_blocking.
allow_user_unblock
boolean
Required

If true, users will be able to unblock their accounts by the link received in notification email.

Default Value: true

policies.account_blocking.
allowed_attempts
integer
Required
min5
max
250

Maximum failed login attempts to block user for specified duration.

Default Value: 10

policies.account_blocking.
block_duration
integer
Required
min60
max
630720000

Number of seconds to block the account.

Default Value: 630720000

policies.account_blocking.
duration
integer
Required
min60
max
7776000

Number of seconds before attempts are reset

Default Value: 7776000

policies.account_blocking.
enabled
boolean
Required

Default Value: true

policies.account_blocking.
notification
boolean
Required

Send an email to user's email address about the activity.

Default Value: true

policies.account_blocking.
reset_after_success
boolean
Required

Reset failed attempts count after successful login.

policies.
brute_force
object
Required
policies.brute_force.
allowed_attempts
integer
Required
min5
max
50

Allowed consecutive login attempts

Default Value: 10

policies.brute_force.
block_duration
integer
Required
min60
max
630720000

Number of seconds to block the IP.

Default Value: 630720000

policies.brute_force.
duration
integer
Required
min60
max
7776000

Number of seconds before attempts are reset

Default Value: 7776000

policies.brute_force.
enabled
boolean
Required

Default Value: true

policies.brute_force.
notification
boolean
Required

Send an email to user's email address about the activity.

Default Value: true

policies.brute_force.
white_list
array<string>
Required

Whitelisted IP addresses.

policies.
password
object
Required

Password policy settings to be enforced to your new users.

policies.password.
custom_chars
string
length
1-64

Require at least on of the given characters

policies.password.
history
integer
min1
max
10

The system will maintain a password history for each user and prevent the reuse of passwords included in the history. The password history can be up to 10 in size. When provided, the system will maintain existing and new users' password history going forward.

policies.password.
lower_case
integer
min0
max
32

Require at least given value of lowercase letters

policies.password.
max
integer
max
128

Maximum number of characters

policies.password.
min
integer
min0

Minimum number of characters

policies.password.
number
integer
min0
max
32

Require at least given value of numbers

policies.password.
upper_case
integer
min0
max
32

Require at least given value of uppercase letters

ttl
object
Required

Lifetime settings of generated tokens defined in seconds.

ttl.
access_token
integer
Required
min30
max
2592000
ttl.
authorization_code
integer
Required
min30
max
86400
ttl.
backchannel_authentication_request
integer
Required
min30
max
86400
ttl.
client_credentials
integer
Required
min30
max
2592000
ttl.
device_code
integer
Required
min30
max
86400
ttl.
id_token
integer
Required
min30
max
31536000
ttl.
refresh_token
integer
Required
min300
max
15552000
ttl.
session
integer
Required
min600
max
15552000
user_self_deletion
object
user_self_deletion.
enabled
boolean

Allow end-users to delete their accounts. This enables the delete-account prompt which you can request to allow users delete their accounts.