Response Body Schema
resultsarray<object>
results. keystorearray<object>
results.keystore. created_atnumber REQUIRED
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. keyobject REQUIRED
Public JWK. You can look at JWK specification from here
results.keystore.key. algstring REQUIRED
results.keystore.key. estring REQUIRED
results.keystore.key. key_opsarray<string>
results.keystore.key. kidstring REQUIRED
results.keystore.key. ktystring REQUIRED
results.keystore.key. nstring REQUIRED
results.keystore.key. usestring REQUIRED
results.keystore.key. x5carray<string>
results.keystore.key. x5tstring
results.keystore.key. x5t#S256string
results.keystore.key. x5ustring
results. regionstring REQUIRED
results. tenant_idstring REQUIRED
Your tenant's identifier.
results. settingsobject REQUIRED
results.settings. api_versionstring REQUIRED
Available Values:2021-07-04
results.settings. auto_sign_inboolean REQUIRED
results.settings. default_strategystring REQUIRED
results.settings. expose_unsafe_errorsboolean REQUIRED
results.settings. extra_paramsarray<string> REQUIRED
results.settings. extra_scopesarray<string> REQUIRED
results.settings. force_email_verificationboolean REQUIRED
results.settings. forgot_password_enabledboolean REQUIRED
results.settings. hash_functionstring REQUIRED
Available Values:bcryptargon2pbkdf2
Default value:"bcrypt"
results.settings. register_enabledboolean REQUIRED
results.settings. tenant_login_urlstring REQUIRED
results.settings. welcome_emails_enabledboolean REQUIRED
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
results.settings. cibaobject REQUIRED
results.settings.ciba. delivery_modestring REQUIRED
Available Values:pingpoll
results.settings.ciba. notifier_endpointstring REQUIRED
results.settings. environment_variablesobject REQUIRED
results.settings. policiesobject REQUIRED
results.settings.policies. account_blockingobject REQUIRED
results.settings.policies.account_blocking. allow_user_unblockboolean REQUIRED
If true, users will be able to unblock their accounts by the link received in notification email.
results.settings.policies.account_blocking. allowed_attemptsinteger REQUIRED
Maximum failed login attempts to block user for specified duration.
results.settings.policies.account_blocking. block_durationinteger REQUIRED
Number of seconds to block the account.
results.settings.policies.account_blocking. durationinteger REQUIRED
Number of seconds before attempts are reset
results.settings.policies.account_blocking. enabledboolean REQUIRED
results.settings.policies.account_blocking. notificationboolean REQUIRED
Send an email to user's email address about the activity.
results.settings.policies.account_blocking. reset_after_successboolean REQUIRED
Reset failed attempts count after successful login.
results.settings.policies. brute_forceobject REQUIRED
results.settings.policies.brute_force. allowed_attemptsinteger REQUIRED
Allowed consecutive login attempts
results.settings.policies.brute_force. block_durationinteger REQUIRED
Number of seconds to block the IP.
results.settings.policies.brute_force. durationinteger REQUIRED
Number of seconds before attempts are reset
results.settings.policies.brute_force. enabledboolean REQUIRED
results.settings.policies.brute_force. notificationboolean REQUIRED
Send an email to user's email address about the activity.
results.settings.policies.brute_force. white_listarray<string> REQUIRED
Whitelisted IP addresses.
results.settings.policies. passwordobject REQUIRED
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. ttlobject REQUIRED
Lifetime settings of generated tokens defined in seconds.