Developers

Update Tenant Settings

Scopes
write:tenant

Path Parameters

tenant_id
string
Required

Tenant id

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: bcryptargon2pbkdf2

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

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
ttl.
authorization_code
integer
min30
ttl.
backchannel_authentication_request
integer
min30
ttl.
client_credentials
integer
min30
ttl.
device_code
integer
min30
ttl.
id_token
integer
min30
ttl.
refresh_token
integer
min30
ttl.
session
integer
min30
PATCH
/tenants/{tenant_id}/settings
1
2
3
4
5
Loading...
Response:
200
Loading...

Response Body Schema

region
string
Required

Value: tr-1

tenant_id
string
Required

Your tenant's identifier.

keystore
array<object>
keystore.
created_at
number
Required

Key creation date in milliseconds since the epoch

keystore.
revoked_at
number

Revocation time in milliseconds since the epoch

keystore.
rotated_at
number

Rotation time in milliseconds since the epoch

keystore.
key
object
Required

Public JWK. You can look at JWK specification from here

keystore.key.
alg
string
Required
keystore.key.
e
string
Required
keystore.key.
kid
string
Required
keystore.key.
kty
string
Required
keystore.key.
n
string
Required
keystore.key.
use
string
Required
keystore.key.
key_ops
array<string>
keystore.key.
x5c
array<string>
keystore.key.
x5t
string
keystore.key.
x5t#S256
string
keystore.key.
x5u
string
settings
object
Required
settings.
api_version
string
Required

Available Values: 2021-07-04

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

Available Values: bcryptargon2pbkdf2

Default Value: "bcrypt"

settings.
register_enabled
boolean
Required
settings.
tenant_login_url
string
Required
settings.
welcome_emails_enabled
boolean
Required
settings.
acr_values
array<string>
settings.
ciba
object
Required
settings.ciba.
delivery_mode
string
Required

Available Values: pingpoll

settings.ciba.
notifier_endpoint
string
Required
settings.
environment_variables
object
Required
settings.
policies
object
Required
settings.policies.
account_blocking
object
Required
settings.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

settings.policies.account_blocking.
allowed_attempts
integer
Required
min5
max
250

Maximum failed login attempts to block user for specified duration.

Default Value: 10

settings.policies.account_blocking.
block_duration
integer
Required
min60
max
630720000

Number of seconds to block the account.

Default Value: 630720000

settings.policies.account_blocking.
duration
integer
Required
min60
max
7776000

Number of seconds before attempts are reset

Default Value: 7776000

settings.policies.account_blocking.
enabled
boolean
Required

Default Value: true

settings.policies.account_blocking.
notification
boolean
Required

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

Default Value: true

settings.policies.account_blocking.
reset_after_success
boolean
Required

Reset failed attempts count after successful login.

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

Allowed consecutive login attempts

Default Value: 10

settings.policies.brute_force.
block_duration
integer
Required
min60
max
630720000

Number of seconds to block the IP.

Default Value: 630720000

settings.policies.brute_force.
duration
integer
Required
min60
max
7776000

Number of seconds before attempts are reset

Default Value: 7776000

settings.policies.brute_force.
enabled
boolean
Required

Default Value: true

settings.policies.brute_force.
notification
boolean
Required

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

Default Value: true

settings.policies.brute_force.
white_list
array<string>
Required

Whitelisted IP addresses.

settings.policies.
password
object
Required

Password policy settings to be enforced to your new users.

settings.policies.password.
custom_chars
string

Require at least on of the given characters

settings.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.

settings.policies.password.
lower_case
integer
min0
max
32

Require at least given value of lowercase letters

settings.policies.password.
max
integer
max
128

Maximum number of characters

settings.policies.password.
min
integer
min0

Minimum number of characters

settings.policies.password.
number
integer
min0
max
32

Require at least given value of numbers

settings.policies.password.
upper_case
integer
min0
max
32

Require at least given value of uppercase letters

settings.
ttl
object
Required

Lifetime settings of generated tokens defined in seconds.

settings.ttl.
access_token
integer
Required
min30
settings.ttl.
authorization_code
integer
Required
min30
settings.ttl.
backchannel_authentication_request
integer
Required
min30
settings.ttl.
client_credentials
integer
Required
min30
settings.ttl.
device_code
integer
Required
min30
settings.ttl.
id_token
integer
Required
min30
settings.ttl.
refresh_token
integer
Required
min30
settings.ttl.
session
integer
min30
settings.
authenticator
object

PlusAuth Authenticator Application related settings

settings.authenticator.
bind_sim
boolean

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

subscription
object
Required
subscription.
customer_id
string
Required
subscription.
id
string
Required
subscription.
plan
string
Required
subscription.
next_invoice
string
subscription.
payment_source_id
string
subscription.
details
object
Required