Create an organization

Creates a new organization.

POST/v3/organizations
JWTorganization:write

Request body

namestringrequired

Name of the organization. Any printable characters, including letters from any script, punctuation and emoji. Cannot contain line breaks, tabs, other control characters, invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

Length: [1,256]Pattern: ^(?!\s)(?!.*\s$)[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$

emailstringrequired

Notification email of the organization.

Length: [1,256]Format: email

allowedUsersintegerrequired

Max number of users the organization is allowed to create. Set to -1 to allow unlimited users.

Range: [-1, 2147483647]Format: int32

descriptionstring

Description for the organization. Any printable characters and line breaks. Cannot contain control characters other than tab, carriage return and line feed, nor invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

Length: [0,256]Pattern: ^(?!\s)(?![\s\S]*\s$)(?:[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]|[\t\n\r])+$

addressobject
resellerIdstring

Unique identifier for the reseller.

Length: [0,256]

customAttributesarray of object

List of custom attribute name/value pairs.

Response

201 Created

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

namestringrequired
emailstringrequired
descriptionstringrequired
allowedUsersintegerrequired

Format: int32

addressobjectrequired
customAttributesarray of objectrequired
organizationAliasstring
resellerIdstring
resellerobject