Get Tenant Settings

Scopes
read:tenant

Path Parameters

tenant_id
string
Zorunlu

Tenant id

GET
/tenants/{tenant_id}/settings
1
2
3
Loading...
Response:
200
Loading...

Response Body Schema

api_version
string
Zorunlu

Mevcut Değerler: 2021-07-04

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

Mevcut Değerler: bcryptargon2pbkdf2

Varsayılan Değer: "bcrypt"

register_enabled
boolean
Zorunlu
tenant_login_url
string
Zorunlu
welcome_emails_enabled
boolean
Zorunlu
ciba
object
Zorunlu
ciba.
delivery_mode
string
Zorunlu

Mevcut Değerler: pingpoll

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

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

Varsayılan Değer: true

policies.account_blocking.
allowed_attempts
integer
Zorunlu
min5
max
250

Maximum failed login attempts to block user for specified duration.

Varsayılan Değer: 10

policies.account_blocking.
block_duration
integer
Zorunlu
min60
max
630720000

Number of seconds to block the account.

Varsayılan Değer: 630720000

policies.account_blocking.
duration
integer
Zorunlu
min60
max
7776000

Number of seconds before attempts are reset

Varsayılan Değer: 7776000

policies.account_blocking.
enabled
boolean
Zorunlu

Varsayılan Değer: true

policies.account_blocking.
notification
boolean
Zorunlu

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

Varsayılan Değer: true

policies.account_blocking.
reset_after_success
boolean
Zorunlu

Reset failed attempts count after successful login.

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

Allowed consecutive login attempts

Varsayılan Değer: 10

policies.brute_force.
block_duration
integer
Zorunlu
min60
max
630720000

Number of seconds to block the IP.

Varsayılan Değer: 630720000

policies.brute_force.
duration
integer
Zorunlu
min60
max
7776000

Number of seconds before attempts are reset

Varsayılan Değer: 7776000

policies.brute_force.
enabled
boolean
Zorunlu

Varsayılan Değer: true

policies.brute_force.
notification
boolean
Zorunlu

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

Varsayılan Değer: true

policies.brute_force.
white_list
array<string>
Zorunlu

Whitelisted IP addresses.

policies.
password
object
Zorunlu

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
Zorunlu

Lifetime settings of generated tokens defined in seconds.

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

PlusAuth Authenticator Application related settings

authenticator.
bind_sim
boolean

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