Create a new Organization User by Template id

Create a new Organization User by Template id

Email confirmation landing page is required as a header

(*)This parameter is mandatory only if its optional parent attribute is defined. Click here for more information.

Request Body Parameters:

ParameterTypeMandatoryDescriptionExample
<customAttribute1><customAttribute1Type>falseRegular custom attribute 1 value
<customAttributeN><customAttributeNType>falseRegular custom attribute N value
_addressobjectfalse
_address.address1stringfalseAn address11 Main St.
_address.address2stringfalseAn address's specificsEntry B, Apartment 1
_address.citystringfalseA cityBoston
_address.countryCodestringtrue(*)A 2-letter country code defined in ISO-3166US
_address.statestringfalseA stateMassachusetts
_address.zipCodestringfalseA zipcode02101
_credentialTypestringfalseWhat type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP
_dateOfBirthstringfalseA person's date of birth A UTC date in the ISO-8601 format2007-12-20
_descriptionstringfalseA description, can be up to 5000 characters longLorem Ipsum
_emailstringfalseAn email address in the RFC-5322 specification[email protected]
_employeeIdstringfalse
_genderstringfalseA persons gender Values:MALE,FEMALE,UNDISCLOSEDFEMALE
_localestringfalseA person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.en-us
_mfaobjectfalse
_mfa.enabledbooleantrue(*)MFA login enabled or disabled
_mfa.expirationInMinutesintegerfalseMFA expiration time in minutes
_nameobjecttrue
_name.firstNamestringtrue(*)A person's first nameJohn
_name.lastNamestringtrue(*)A person's last nameSmith
_ownerOrganizationobjecttrue
_ownerOrganization.idstringtrue(*)A UUID formatted string3fa85f64-5717-4562-b3fc-2c963f66afa6
_phonestringfalseA person's phone An E.164 formatted phone number+12345678901
_templateIdstringtrueThe id of a template that is configured in the settings service.3fa85f64-5717-4562-b3fc-2c963f66afa6

This API requires PROTECTED_API permission(s).

Body Params
_name
object
required
string

A description, can be up to 5000 characters long

string

An email address in the RFC-5322 specification

string

A person's phone An E.164 formatted phone number

string

A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.

string
enum

A persons gender

Allowed:
string

A person's date of birth A UTC date in the ISO-8601 format

_address
object
_mfa
object
string
enum

What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD

Allowed:
string
uuid
required

The id of a template that is configured in the settings service.

_ownerOrganization
object
required
Headers
string
enum
Defaults to async

X-Execution-Mode — Optional header to control execution mode.

Use sync to make the API wait until all background operations complete before returning a response.

If omitted, the request is processed asynchronously (default).

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json