Skip to content
Developers
No results found.

Create Tenant

Request Body

region
string
Required

Value: tr-1

tenant_id
string
Required
length
3-48

Your tenant's identifier.

settings
object
settings.
acr_values
array<string>
settings.
api_version
string

Available Values: 2021-07-04

settings.
auto_sign_in
boolean
settings.
default_strategy
string
settings.
expose_unsafe_errors
boolean
settings.
extra_params
array<string>
settings.
extra_scopes
array<string>
settings.
force_email_verification
boolean
settings.
forgot_password_enabled
boolean
settings.
hash_function
string

Available Values: bcryptargon2

Default Value: "bcrypt"

settings.
register_enabled
boolean
settings.
tenant_login_url
string
settings.
welcome_emails_enabled
boolean
settings.
authenticator
object

PlusAuth Authenticator Application related settings

settings.authenticator.
bind_sim
boolean

Should authenticator application logout if a SIM card change detected on device

settings.
ciba
object
settings.ciba.
delivery_mode
string

Available Values: pingpoll

settings.ciba.
notifier_endpoint
string
settings.
environment_variables
object
settings.
policies
object
settings.policies.
account_blocking
object
settings.policies.account_blocking.
allow_user_unblock
boolean

If true, users will be able to unblock their accounts by the link received in notification email.

Default Value: true

settings.policies.account_blocking.
allowed_attempts
integer
min5
max
250

Maximum failed login attempts to block user for specified duration.

Default Value: 10

settings.policies.account_blocking.
block_duration
integer
min60
max
630720000

Number of seconds to block the account.

Default Value: 630720000

settings.policies.account_blocking.
duration
integer
min60
max
7776000

Number of seconds before attempts are reset

Default Value: 7776000

settings.policies.account_blocking.
enabled
boolean

Default Value: true

settings.policies.account_blocking.
notification
boolean

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

Default Value: true

settings.policies.account_blocking.
reset_after_success
boolean

Reset failed attempts count after successful login.

settings.policies.
brute_force
object
settings.policies.brute_force.
allowed_attempts
integer
min5
max
50

Allowed consecutive login attempts

Default Value: 10

settings.policies.brute_force.
block_duration
integer
min60
max
630720000

Number of seconds to block the IP.

Default Value: 630720000

settings.policies.brute_force.
duration
integer
min60
max
7776000

Number of seconds before attempts are reset

Default Value: 7776000

settings.policies.brute_force.
enabled
boolean

Default Value: true

settings.policies.brute_force.
notification
boolean

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

Default Value: true

settings.policies.brute_force.
white_list
array<string>

Whitelisted IP addresses.

settings.policies.
password
object

Password policy settings to be enforced to your new users.

settings.policies.password.
custom_chars
string
length
1-64

Require at least on of the given characters

settings.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.

settings.policies.password.
lower_case
integer
min0
max
32

Require at least given value of lowercase letters

settings.policies.password.
max
integer
max
128

Maximum number of characters

settings.policies.password.
min
integer
min0

Minimum number of characters

settings.policies.password.
number
integer
min0
max
32

Require at least given value of numbers

settings.policies.password.
upper_case
integer
min0
max
32

Require at least given value of uppercase letters

settings.
ttl
object

Lifetime settings of generated tokens defined in seconds.

settings.ttl.
access_token
integer
min30
max
2592000
settings.ttl.
authorization_code
integer
min30
max
86400
settings.ttl.
backchannel_authentication_request
integer
min30
max
86400
settings.ttl.
client_credentials
integer
min30
max
2592000
settings.ttl.
device_code
integer
min30
max
86400
settings.ttl.
id_token
integer
min30
max
31536000
settings.ttl.
refresh_token
integer
min300
max
15552000
settings.ttl.
session
integer
min600
max
15552000
settings.
user_self_deletion
object
settings.user_self_deletion.
enabled
boolean

Allow end-users to delete their accounts. This enables the delete-account prompt which you can request to allow users delete their accounts.

POST
/tenants
cURL
cURLC#DartGoJavaJavaScriptPHPPythonRubyRustSwift
1
2
3
4
Loading...
Response
200
200
Loading...

Response Body Schema

created_at
string
Required

Creation date in the ISO 8601 format according to universal time.

region
string
Required

Value: tr-1

tenant_id
string
Required
length
3-48

Your tenant's identifier.

keystore
array<object>
keystore.
created_at
number
Required

Key creation date in milliseconds since the epoch

keystore.
revoked_at
integer

Revocation time in milliseconds since the epoch

keystore.
rotated_at
integer

Rotation time in milliseconds since the epoch

keystore.
key
object
Required

Public JWK. You can look at JWK specification from here

keystore.key.
alg
string
Required
keystore.key.
e
string
Required
keystore.key.
kid
string
Required
keystore.key.
kty
string
Required
keystore.key.
n
string
Required
keystore.key.
use
string
Required
keystore.key.
key_ops
array<string>
keystore.key.
x5c
array<string>
keystore.key.
x5t
string
keystore.key.
x5t#S256
string
keystore.key.
x5u
string
updated_at
string

Update date in the ISO 8601 format according to universal time.

settings
object
Required
settings.
acr_values
array<string>
Required
settings.
auto_sign_in
boolean
Required
settings.
expose_unsafe_errors
boolean
Required
settings.
extra_params
array<string>
Required
settings.
extra_scopes
array<string>
Required
settings.
force_email_verification
boolean
Required
settings.
forgot_password_enabled
boolean
Required
settings.
hash_function
string
Required

Available Values: bcryptargon2

Default Value: "bcrypt"

settings.
register_enabled
boolean
Required
settings.
tenant_login_url
string
Required
settings.
welcome_emails_enabled
boolean
Required
settings.
api_version
string

Available Values: 2021-07-04

settings.
default_strategy
string
settings.
authenticator
object
Required

PlusAuth Authenticator Application related settings

settings.authenticator.
bind_sim
boolean
Required

Should authenticator application logout if a SIM card change detected on device

settings.
ciba
object
Required
settings.ciba.
delivery_mode
string
Required

Available Values: pingpoll

settings.ciba.
notifier_endpoint
string
Required
settings.
environment_variables
object
Required
settings.
policies
object
Required
settings.policies.
account_blocking
object
Required
settings.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.

Default Value: true

settings.policies.account_blocking.
allowed_attempts
integer
Required
min5
max
250

Maximum failed login attempts to block user for specified duration.

Default Value: 10

settings.policies.account_blocking.
block_duration
integer
Required
min60
max
630720000

Number of seconds to block the account.

Default Value: 630720000

settings.policies.account_blocking.
duration
integer
Required
min60
max
7776000

Number of seconds before attempts are reset

Default Value: 7776000

settings.policies.account_blocking.
enabled
boolean
Required

Default Value: true

settings.policies.account_blocking.
notification
boolean
Required

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

Default Value: true

settings.policies.account_blocking.
reset_after_success
boolean
Required

Reset failed attempts count after successful login.

settings.policies.
brute_force
object
Required
settings.policies.brute_force.
allowed_attempts
integer
Required
min5
max
50

Allowed consecutive login attempts

Default Value: 10

settings.policies.brute_force.
block_duration
integer
Required
min60
max
630720000

Number of seconds to block the IP.

Default Value: 630720000

settings.policies.brute_force.
duration
integer
Required
min60
max
7776000

Number of seconds before attempts are reset

Default Value: 7776000

settings.policies.brute_force.
enabled
boolean
Required

Default Value: true

settings.policies.brute_force.
notification
boolean
Required

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

Default Value: true

settings.policies.brute_force.
white_list
array<string>
Required

Whitelisted IP addresses.

settings.policies.
password
object
Required

Password policy settings to be enforced to your new users.

settings.policies.password.
custom_chars
string
length
1-64

Require at least on of the given characters

settings.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.

settings.policies.password.
lower_case
integer
min0
max
32

Require at least given value of lowercase letters

settings.policies.password.
max
integer
max
128

Maximum number of characters

settings.policies.password.
min
integer
min0

Minimum number of characters

settings.policies.password.
number
integer
min0
max
32

Require at least given value of numbers

settings.policies.password.
upper_case
integer
min0
max
32

Require at least given value of uppercase letters

settings.
ttl
object
Required

Lifetime settings of generated tokens defined in seconds.

settings.ttl.
access_token
integer
Required
min30
max
2592000
settings.ttl.
authorization_code
integer
Required
min30
max
86400
settings.ttl.
backchannel_authentication_request
integer
Required
min30
max
86400
settings.ttl.
client_credentials
integer
Required
min30
max
2592000
settings.ttl.
device_code
integer
Required
min30
max
86400
settings.ttl.
id_token
integer
Required
min30
max
31536000
settings.ttl.
refresh_token
integer
Required
min300
max
15552000
settings.ttl.
session
integer
Required
min600
max
15552000
settings.
user_self_deletion
object
settings.user_self_deletion.
enabled
boolean

Allow end-users to delete their accounts. This enables the delete-account prompt which you can request to allow users delete their accounts.

subscription
object
Required

Subscription details of tenant

subscription.
plan
string
Required

Applied plan name

Available Values: freebasicproenterpriseon-premise

subscription.
expires_at
string
subscription.
issued_at
string
subscription.
plan_details
object
Required

Details about the subscription usage

subscription.plan_details.
active_user
boolean | boolean | integer | object
subscription.plan_details.
administrators
boolean | integer
subscription.plan_details.
ciba
boolean

Is feature enabled or not

Examples: false 

subscription.plan_details.
connections.e_devlet
boolean | integer
subscription.plan_details.
connections.ldap
boolean | integer
subscription.plan_details.
connections.passwordless
boolean | integer
subscription.plan_details.
connections.saml
boolean | integer
subscription.plan_details.
connections.social
boolean | integer
subscription.plan_details.
custom_algorithm
boolean

Is feature enabled or not

Examples: false 

subscription.plan_details.
custom_domain
boolean | integer
subscription.plan_details.
custom_password_policy
boolean

Is feature enabled or not

Examples: false 

subscription.plan_details.
custom_token_ttl
boolean

Is feature enabled or not

Examples: false 

subscription.plan_details.
fapi
boolean

Is feature enabled or not

Examples: false 

subscription.plan_details.
hooks
boolean | integer
subscription.plan_details.
log_retention
integer

Log retention period in days

Examples: 30 

subscription.plan_details.
log_shipping
boolean

Is feature enabled or not

Examples: false 

subscription.plan_details.
log_signing
boolean

Is feature enabled or not

Examples: false 

subscription.plan_details.
max_clients
integer

Number of defined feature

Examples: 100 

subscription.plan_details.
max_resources
integer

Number of defined feature

Examples: 100 

subscription.plan_details.
max_tenants
integer

Number of defined feature

Examples: 100 

subscription.plan_details.
max_users
integer

Number of defined feature

Examples: 100 

subscription.plan_details.
mfa
boolean | integer
subscription.plan_details.
mfa.e-sign
boolean
subscription.plan_details.
mfa.email
boolean
subscription.plan_details.
mfa.fv
boolean
subscription.plan_details.
mfa.otp
boolean
subscription.plan_details.
mfa.push
boolean
subscription.plan_details.
mfa.sms
boolean
subscription.plan_details.
mfa.webauthn
boolean
subscription.plan_details.
password_history
boolean

Is feature enabled or not

Examples: false 

subscription.plan_details.
rbac_management
boolean

Is feature enabled or not

Examples: false 

subscription.plan_details.
user_management
boolean

Is feature enabled or not

Examples: false 

subscription.
metadata
object