Create Tenant
Request Body
PlusAuth Authenticator Application related settings
If true
, users will be able to unblock their accounts by the link received in notification email.
Varsayılan Değer: true
Maximum failed login attempts to block user for specified duration.
Varsayılan Değer: 10
Number of seconds to block the account.
Varsayılan Değer: 630720000
Number of seconds before attempts are reset
Varsayılan Değer: 7776000
Send an email to user's email address about the activity.
Varsayılan Değer: true
Allowed consecutive login attempts
Varsayılan Değer: 10
Number of seconds to block the IP.
Varsayılan Değer: 630720000
Number of seconds before attempts are reset
Varsayılan Değer: 7776000
Send an email to user's email address about the activity.
Varsayılan Değer: true
Password policy settings to be enforced to your new users.
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.
Require at least given value of lowercase letters
Lifetime settings of generated tokens defined in seconds.
Response Body Schema
created_atstringZorunlu
Creation date in the ISO 8601 format according to universal time.
regionstringZorunlu
Değer: tr-1
tenant_idstringZorunlu
Your tenant's identifier.
keystorearray<object>
keystore. created_atnumberZorunlu
Key creation date in milliseconds since the epoch
keystore. revoked_atinteger
Revocation time in milliseconds since the epoch
keystore. rotated_atinteger
Rotation time in milliseconds since the epoch
keystore. keyobjectZorunlu
Public JWK. You can look at JWK specification from here
keystore.key. algstringZorunlu
keystore.key. estringZorunlu
keystore.key. kidstringZorunlu
keystore.key. ktystringZorunlu
keystore.key. nstringZorunlu
keystore.key. usestringZorunlu
keystore.key. key_opsarray<string>
keystore.key. x5carray<string>
keystore.key. x5tstring
keystore.key. x5t#S256string
keystore.key. x5ustring
updated_atstring
Update date in the ISO 8601 format according to universal time.
settingsobjectZorunlu
settings. acr_valuesarray<string>Zorunlu
settings. auto_sign_inbooleanZorunlu
settings. expose_unsafe_errorsbooleanZorunlu
settings. extra_paramsarray<string>Zorunlu
settings. extra_scopesarray<string>Zorunlu
settings. force_email_verificationbooleanZorunlu
settings. forgot_password_enabledbooleanZorunlu
settings. hash_functionstringZorunlu
Mevcut Değerler: bcrypt
argon2
Varsayılan Değer: "bcrypt"
settings. register_enabledbooleanZorunlu
settings. tenant_login_urlstringZorunlu
settings. welcome_emails_enabledbooleanZorunlu
settings. api_versionstring
Mevcut Değerler: 2021-07-04
Varsayılan Değer: "2021-07-04"
settings. default_strategystring
settings. authenticatorobjectZorunlu
PlusAuth Authenticator Application related settings
settings.authenticator. bind_simbooleanZorunlu
Should authenticator application logout if a SIM card change detected on device
settings. cibaobjectZorunlu
settings.ciba. delivery_modestringZorunlu
Mevcut Değerler: ping
poll
Varsayılan Değer: "ping"
settings.ciba. notifier_endpointstringZorunlu
settings. environment_variablesobjectZorunlu
settings. policiesobjectZorunlu
settings.policies. account_blockingobjectZorunlu
settings.policies.account_blocking. allow_user_unblockbooleanZorunlu
If true
, users will be able to unblock their accounts by the link received in notification email.
Varsayılan Değer: true
settings.policies.account_blocking. allowed_attemptsnumberZorunlu
Maximum failed login attempts to block user for specified duration.
Varsayılan Değer: 10
settings.policies.account_blocking. block_durationnumberZorunlu
Number of seconds to block the account.
Varsayılan Değer: 630720000
settings.policies.account_blocking. durationnumberZorunlu
Number of seconds before attempts are reset
Varsayılan Değer: 7776000
settings.policies.account_blocking. enabledbooleanZorunlu
Varsayılan Değer: true
settings.policies.account_blocking. notificationbooleanZorunlu
Send an email to user's email address about the activity.
Varsayılan Değer: true
settings.policies.account_blocking. reset_after_successbooleanZorunlu
Reset failed attempts count after successful login.
settings.policies. brute_forceobjectZorunlu
settings.policies.brute_force. allowed_attemptsnumberZorunlu
Allowed consecutive login attempts
Varsayılan Değer: 10
settings.policies.brute_force. block_durationnumberZorunlu
Number of seconds to block the IP.
Varsayılan Değer: 630720000
settings.policies.brute_force. durationnumberZorunlu
Number of seconds before attempts are reset
Varsayılan Değer: 7776000
settings.policies.brute_force. enabledbooleanZorunlu
Varsayılan Değer: true
settings.policies.brute_force. notificationbooleanZorunlu
Send an email to user's email address about the activity.
Varsayılan Değer: true
settings.policies.brute_force. white_listarray<string>Zorunlu
Whitelisted IP addresses.
settings.policies. passwordobjectZorunlu
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. ttlobjectZorunlu
Lifetime settings of generated tokens defined in seconds.
settings.ttl. access_tokennumberZorunlu
settings.ttl. backchannel_authentication_requestnumberZorunlu
settings.ttl. client_credentialsnumberZorunlu
settings.ttl. device_codenumberZorunlu
settings.ttl. id_tokennumberZorunlu
settings.ttl. refresh_tokennumberZorunlu
settings.ttl. sessionnumberZorunlu
settings. user_self_deletionobject
settings.user_self_deletion. enabledboolean
Allow end-users to delete their accounts. This enables the delete-account
prompt which you can request to allow users delete their accounts.
subscriptionobjectZorunlu
Subscription details of tenant
subscription. planstringZorunlu
Applied plan name
Mevcut Değerler: free
basic
pro
enterprise
on-premise
Varsayılan Değer: "free"
subscription. expires_atstring
subscription. issued_atstring
subscription. plan_detailsobjectZorunlu
Details about the subscription usage
subscription.plan_details. active_userboolean | boolean | number | object
subscription.plan_details. administratorsboolean | number
subscription.plan_details. cibaboolean
Is feature enabled or not
Examples: false
subscription.plan_details. connections.enterprise.e_devletboolean | number
subscription.plan_details. connections.enterprise.ldapboolean | number
subscription.plan_details. connections.enterprise.samlboolean | number
subscription.plan_details. connections.passwordlessboolean | number
subscription.plan_details. custom_algorithmboolean
Is feature enabled or not
Examples: false
subscription.plan_details. custom_domainboolean | number
subscription.plan_details. custom_password_policyboolean
Is feature enabled or not
Examples: false
subscription.plan_details. custom_token_ttlboolean
Is feature enabled or not
Examples: false
subscription.plan_details. fapiboolean
Is feature enabled or not
Examples: false
subscription.plan_details. hooksboolean | number
subscription.plan_details. log_retentionnumber
Log retention period in days
Examples: 30
subscription.plan_details. log_shippingboolean
Is feature enabled or not
Examples: false
subscription.plan_details. log_signingboolean
Is feature enabled or not
Examples: false
subscription.plan_details. max_clientsnumber
Number of defined feature
Examples: 100
subscription.plan_details. max_resourcesnumber
Number of defined feature
Examples: 100
subscription.plan_details. max_tenantsnumber
Number of defined feature
Examples: 100
subscription.plan_details. max_usersnumber
Number of defined feature
Examples: 100
subscription.plan_details. mfaboolean | number
subscription.plan_details. mfa.e_signboolean
subscription.plan_details. mfa.emailboolean
subscription.plan_details. mfa.fvboolean
subscription.plan_details. mfa.otpboolean
subscription.plan_details. mfa.pushboolean
subscription.plan_details. mfa.smsboolean
subscription.plan_details. mfa.webauthnboolean
subscription.plan_details. password_historyboolean
Is feature enabled or not
Examples: false
subscription.plan_details. radiusboolean
Is feature enabled or not
Examples: false
subscription.plan_details. rbac_managementboolean
Is feature enabled or not
Examples: false
subscription.plan_details. user_managementboolean
Is feature enabled or not
Examples: false