Response Body Schema
resultsarray<object>
results. regionstringRequired
Value: tr-1
results. tenant_idstringRequired
Your tenant's identifier.
results. keystorearray<object>
results.keystore. created_atnumberRequired
Key creation date in milliseconds since the epoch
results.keystore. revoked_atnumber
Revocation time in milliseconds since the epoch
results.keystore. rotated_atnumber
Rotation time in milliseconds since the epoch
results.keystore. keyobjectRequired
Public JWK. You can look at JWK specification from here
results.keystore.key. algstringRequired
results.keystore.key. estringRequired
results.keystore.key. kidstringRequired
results.keystore.key. ktystringRequired
results.keystore.key. nstringRequired
results.keystore.key. usestringRequired
results.keystore.key. key_opsarray<string>
results.keystore.key. x5carray<string>
results.keystore.key. x5tstring
results.keystore.key. x5t#S256string
results.keystore.key. x5ustring
results. settingsobjectRequired
results.settings. api_versionstringRequired
Available Values: 2021-07-04
results.settings. auto_sign_inbooleanRequired
results.settings. default_strategystringRequired
results.settings. expose_unsafe_errorsbooleanRequired
results.settings. extra_paramsarray<string>Required
results.settings. extra_scopesarray<string>Required
results.settings. force_email_verificationbooleanRequired
results.settings. forgot_password_enabledbooleanRequired
results.settings. hash_functionstringRequired
Available Values: bcrypt
argon2
pbkdf2
Default Value: "bcrypt"
results.settings. register_enabledbooleanRequired
results.settings. tenant_login_urlstringRequired
results.settings. welcome_emails_enabledbooleanRequired
results.settings. acr_valuesarray<string>
results.settings. cibaobjectRequired
results.settings.ciba. delivery_modestringRequired
Available Values: ping
poll
results.settings.ciba. notifier_endpointstringRequired
results.settings. environment_variablesobjectRequired
results.settings. policiesobjectRequired
results.settings.policies. account_blockingobjectRequired
results.settings.policies.account_blocking. allow_user_unblockbooleanRequired
If true
, users will be able to unblock their accounts by the link received in notification email.
Default Value: true
results.settings.policies.account_blocking. allowed_attemptsintegerRequired
Maximum failed login attempts to block user for specified duration.
Default Value: 10
results.settings.policies.account_blocking. block_durationintegerRequired
Number of seconds to block the account.
Default Value: 630720000
results.settings.policies.account_blocking. durationintegerRequired
Number of seconds before attempts are reset
Default Value: 7776000
results.settings.policies.account_blocking. enabledbooleanRequired
Default Value: true
results.settings.policies.account_blocking. notificationbooleanRequired
Send an email to user's email address about the activity.
Default Value: true
results.settings.policies.account_blocking. reset_after_successbooleanRequired
Reset failed attempts count after successful login.
results.settings.policies. brute_forceobjectRequired
results.settings.policies.brute_force. allowed_attemptsintegerRequired
Allowed consecutive login attempts
Default Value: 10
results.settings.policies.brute_force. block_durationintegerRequired
Number of seconds to block the IP.
Default Value: 630720000
results.settings.policies.brute_force. durationintegerRequired
Number of seconds before attempts are reset
Default Value: 7776000
results.settings.policies.brute_force. enabledbooleanRequired
Default Value: true
results.settings.policies.brute_force. notificationbooleanRequired
Send an email to user's email address about the activity.
Default Value: true
results.settings.policies.brute_force. white_listarray<string>Required
Whitelisted IP addresses.
results.settings.policies. passwordobjectRequired
Password policy settings to be enforced to your new users.
results.settings.policies.password. custom_charsstring
Require at least on of the given characters
results.settings.policies.password. historyinteger
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.
results.settings.policies.password. lower_caseinteger
Require at least given value of lowercase letters
results.settings.policies.password. maxinteger
Maximum number of characters
results.settings.policies.password. mininteger
Minimum number of characters
results.settings.policies.password. numberinteger
Require at least given value of numbers
results.settings.policies.password. upper_caseinteger
Require at least given value of uppercase letters
results.settings. ttlobjectRequired
Lifetime settings of generated tokens defined in seconds.
results.settings.ttl. access_tokenintegerRequired
results.settings.ttl. authorization_codeintegerRequired
results.settings.ttl. backchannel_authentication_requestintegerRequired
results.settings.ttl. client_credentialsintegerRequired
results.settings.ttl. device_codeintegerRequired
results.settings.ttl. id_tokenintegerRequired
results.settings.ttl. refresh_tokenintegerRequired
results.settings.ttl. sessioninteger
results.settings. authenticatorobject
PlusAuth Authenticator Application related settings
results.settings.authenticator. bind_simboolean
Should authenticator application logout if a SIM card change detected on device