Request Body
Response Body Schema
keystorearray<object>
keystore. created_atnumber REQUIRED
Key creation date in milliseconds since the epoch
keystore. revoked_atnumber
Revocation time in milliseconds since the epoch
keystore. rotated_atnumber
Rotation time in milliseconds since the epoch
keystore. keyobject REQUIRED
Public JWK. You can look at JWK specification from here
keystore.key. algstring REQUIRED
keystore.key. estring REQUIRED
keystore.key. key_opsarray<string>
keystore.key. kidstring REQUIRED
keystore.key. ktystring REQUIRED
keystore.key. nstring REQUIRED
keystore.key. usestring REQUIRED
keystore.key. x5carray<string>
keystore.key. x5tstring
keystore.key. x5t#S256string
keystore.key. x5ustring
regionstring REQUIRED
tenant_idstring REQUIRED
Your tenant's identifier.
settingsobject REQUIRED
settings. api_versionstring REQUIRED
Available Values:2021-07-04
settings. auto_sign_inboolean REQUIRED
settings. default_strategystring REQUIRED
settings. expose_unsafe_errorsboolean REQUIRED
settings. extra_paramsarray<string> REQUIRED
settings. extra_scopesarray<string> REQUIRED
settings. force_email_verificationboolean REQUIRED
settings. forgot_password_enabledboolean REQUIRED
settings. hash_functionstring REQUIRED
Available Values:bcrypt
argon2
pbkdf2
Default value:"bcrypt"
settings. register_enabledboolean REQUIRED
settings. tenant_login_urlstring REQUIRED
settings. welcome_emails_enabledboolean REQUIRED
settings. authenticatorobject
PlusAuth Authenticator Application related settings
settings.authenticator. bind_simboolean
Should authenticator application logout if a SIM card change detected on device
settings. cibaobject REQUIRED
settings.ciba. delivery_modestring REQUIRED
Available Values:ping
poll
settings.ciba. notifier_endpointstring REQUIRED
settings. environment_variablesobject REQUIRED
settings. policiesobject REQUIRED
settings.policies. account_blockingobject REQUIRED
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.
settings.policies.account_blocking. allowed_attemptsinteger REQUIRED
Maximum failed login attempts to block user for specified duration.
settings.policies.account_blocking. block_durationinteger REQUIRED
Number of seconds to block the account.
settings.policies.account_blocking. durationinteger REQUIRED
Number of seconds before attempts are reset
settings.policies.account_blocking. enabledboolean REQUIRED
settings.policies.account_blocking. notificationboolean REQUIRED
Send an email to user's email address about the activity.
settings.policies.account_blocking. reset_after_successboolean REQUIRED
Reset failed attempts count after successful login.
settings.policies. brute_forceobject REQUIRED
settings.policies.brute_force. allowed_attemptsinteger REQUIRED
Allowed consecutive login attempts
settings.policies.brute_force. block_durationinteger REQUIRED
Number of seconds to block the IP.
settings.policies.brute_force. durationinteger REQUIRED
Number of seconds before attempts are reset
settings.policies.brute_force. enabledboolean REQUIRED
settings.policies.brute_force. notificationboolean REQUIRED
Send an email to user's email address about the activity.
settings.policies.brute_force. white_listarray<string> REQUIRED
Whitelisted IP addresses.
settings.policies. passwordobject REQUIRED
Password policy settings to be enforced to your new users.
settings.policies.password. custom_charsstring
Require at least on of the given characters
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.
settings.policies.password. lower_caseinteger
Require at least given value of lowercase letters
settings.policies.password. maxinteger
Maximum number of characters
settings.policies.password. mininteger
Minimum number of characters
settings.policies.password. numberinteger
Require at least given value of numbers
settings.policies.password. upper_caseinteger
Require at least given value of uppercase letters
settings. ttlobject REQUIRED
Lifetime settings of generated tokens defined in seconds.