Documentation

Mistake on this page? Email us

This object represents an account creation request.

Index

Type aliases

MfaStatusEnum

MfaStatusEnum: "enforced" | "optional"

Properties

address_line1

address_line1: string

Postal address line 1, not longer than 100 characters. Required for commercial accounts only.

address_line2

address_line2: string

Postal address line 2, not longer than 100 characters.

aliases

aliases: Array<string>

An array of aliases, not more than 10. An alias is not shorter than 8 and not longer than 100 characters.

city

city: string

The city part of the postal address, not longer than 100 characters. Required for commercial accounts only.

company

company: string

The name of the company, not longer than 100 characters. Required for commercial accounts only.

contact

contact: string

The name of the contact person for this account, not longer than 100 characters. Required for commercial accounts only.

country

country: string

The country part of the postal address, not longer than 100 characters. Required for commercial accounts only.

custom_fields

custom_fields: object

Account's custom properties as key-value pairs, with a maximum of 10 keys. The maximum length of a key is 100 characters. The values are handled as strings and the maximum length for a value is 1000 characters.

Type declaration

  • [key: string]: string

display_name

display_name: string

The display name for the account, not longer than 100 characters.

email

email: string

The company email address for this account, not longer than 254 characters. Required for commercial accounts only.

end_market

end_market: string

The end market for this account, not longer than 100 characters.

expiration_warning_threshold

expiration_warning_threshold: string

Indicates how many days before account expiration a notification email should be sent. Valid values are: 1-180.

idle_timeout

idle_timeout: string

The reference token expiration time in minutes for this account. Between 1 and 120 minutes.

mfa_status

mfa_status: MfaStatusEnum

The enforcement status of setting up the multi-factor authentication. 'Enforced' means that setting up the MFA is required after login. 'Optional' means that the MFA is not required.

notification_emails

notification_emails: Array<string>

A list of notification email addresses.

password_policy

password_policy: PasswordPolicy

Password policy for this account.

phone_number

phone_number: string

The phone number of a representative of the company, not longer than 100 characters.

postal_code

postal_code: string

The postal code part of the postal address, not longer than 100 characters.

state

state: string

The state part of the postal address, not longer than 100 characters.