post https://example.com/organization/v1/organizations
Create a new Organization by Template id
Organization admin will be created and set as the admin for the created organization.
Confirmation email with configured landing page will be sent.
(*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information.
Request Body Parameters:
| Parameter | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| <customAttribute1> | <customAttribute1Type> | false | Regular custom attribute 1 value | |
| <customAttributeN> | <customAttributeNType> | false | Regular custom attribute N value | |
| _description | string | false | A description, can be up to 5000 characters long | Lorem Ipsum |
| _headquarters | object | false | ||
| _headquarters.address1 | string | false | An address | 11 Main St. |
| _headquarters.address2 | string | false | An address's specifics | Entry B, Apartment 1 |
| _headquarters.city | string | false | A city | Boston |
| _headquarters.countryCode | string | true(*) | A 2-letter country code defined in ISO-3166 | US |
| _headquarters.state | string | false | A state | Massachusetts |
| _headquarters.zipCode | string | false | A zipcode | 02101 |
| _locale | string | false | Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase. | en-us |
| _name | string | true | An organization's name | Example Inc. |
| _phone | string | false | An E.164 formatted phone number | +12345678901 |
| _primaryAdministrator | object | true | ||
| _primaryAdministrator._address | object | false | ||
| _primaryAdministrator._address.address1 | string | false | An address | 11 Main St. |
| _primaryAdministrator._address.address2 | string | false | An address's specifics | Entry B, Apartment 1 |
| _primaryAdministrator._address.city | string | false | A city | Boston |
| _primaryAdministrator._address.countryCode | string | true(*) | A 2-letter country code defined in ISO-3166 | US |
| _primaryAdministrator._address.state | string | false | A state | Massachusetts |
| _primaryAdministrator._address.zipCode | string | false | A zipcode | 02101 |
| _primaryAdministrator._credentialType | string | false | What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP | |
| _primaryAdministrator._dateOfBirth | string | false | A person's date of birth A UTC date in the ISO-8601 format | 2007-12-20 |
| _primaryAdministrator._description | string | false | A description, can be up to 5000 characters long | Lorem Ipsum |
| _primaryAdministrator._email | string | false | An email address in the RFC-5322 specification | [email protected] |
| _primaryAdministrator._employeeId | string | false | ||
| _primaryAdministrator._gender | string | false | A persons gender Values:MALE,FEMALE,UNDISCLOSED | FEMALE |
| _primaryAdministrator._locale | string | false | A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase. | en-us |
| _primaryAdministrator._mfa | object | false | ||
| _primaryAdministrator._mfa.enabled | boolean | true(*) | MFA login enabled or disabled | |
| _primaryAdministrator._mfa.expirationInMinutes | integer | false | MFA expiration time in minutes | |
| _primaryAdministrator._name | object | true(*) | ||
| _primaryAdministrator._name.firstName | string | true(*) | A person's first name | John |
| _primaryAdministrator._name.lastName | string | true(*) | A person's last name | Smith |
| _primaryAdministrator._phone | string | false | A person's phone An E.164 formatted phone number | +12345678901 |
| _templateId | string | true | The id of a template that is configured in the settings service. | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
| _timezone | string | false | A java time zone supported by the java runtime environment | Europe/Oslo |
This API requires ORGANIZATION_CREATE_ORGANIZATION permission(s).