Türkçe dil desteğimiz henüz tamamlandı. Eksik sayfalar veya bölümlerle karşılaşmanız durumunda İngilizce dilini seçerek sayfanın orjinalini görebilirsiniz.

Get Tenant Settings

Scopes
read:tenant

Path Parameters

tenant_id
string
REQUIRED

Tenant id

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

Response Body Schema

api_version
string
REQUIRED

Available Values:2021-07-04

auto_sign_in
boolean
REQUIRED
default_strategy
string
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:bcryptargon2pbkdf2

Default value:"bcrypt"

register_enabled
boolean
REQUIRED
tenant_login_url
string
REQUIRED
welcome_emails_enabled
boolean
REQUIRED
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
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.

policies.account_blocking.
allowed_attempts
integer
REQUIRED
min5
max
250

Maximum failed login attempts to block user for specified duration.

policies.account_blocking.
block_duration
integer
REQUIRED
min60
max
630720000

Number of seconds to block the account.

policies.account_blocking.
duration
integer
REQUIRED
min60
max
7776000

Number of seconds before attempts are reset

policies.account_blocking.
enabled
boolean
REQUIRED
policies.account_blocking.
notification
boolean
REQUIRED

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

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

policies.brute_force.
block_duration
integer
REQUIRED
min60
max
630720000

Number of seconds to block the IP.

policies.brute_force.
duration
integer
REQUIRED
min60
max
7776000

Number of seconds before attempts are reset

policies.brute_force.
enabled
boolean
REQUIRED
policies.brute_force.
notification
boolean
REQUIRED

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

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

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
ttl.
authorization_code
integer
REQUIRED
min30
ttl.
backchannel_authentication_request
integer
REQUIRED
min30
ttl.
client_credentials
integer
REQUIRED
min30
ttl.
device_code
integer
REQUIRED
min30
ttl.
id_token
integer
REQUIRED
min30
ttl.
refresh_token
integer
REQUIRED
min30
ttl.
session
integer
min30