Create an active Caregiver by Template name, without an invitation email

post

https://example.com/organization/v1/users/caregivers/active/templates/{templateName}

This API is intended for automated flows, such as automated tests, where a user must be able to log in right away without going through the invitation email. For regular onboarding of real users, use the regular create API, which sends an invitation email.

Creates a user that is active immediately, using the username and password supplied in the request.

Unlike the regular create API, no invitation email is sent and there is nothing for the user to accept: the credentials in this request are the user's credentials, so they can log in as soon as this call returns. The created user is therefore returned with _invitationAccepted set to true.

The template is identified by name in the path, and custom attributes can be specified in the request body.

The password must satisfy the password policy configured for the environment. A password that does not, or a username that is already taken, fails with USER_CREATION_FAILED.

MFA is applied exactly as the template configures it. If the template requires MFA, then so does this user's login, which is worth checking before using this API to create users for automated tests.

(*)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
_address	object	false
_address.address1	string	false	An address	11 Main St.
_address.address2	string	false	An address's specifics	Entry B, Apartment 1
_address.city	string	false	A city	Boston
_address.countryCode	string	true(*)	A 2-letter country code defined in ISO-3166	US
_address.state	string	false	A state	Massachusetts
_address.zipCode	string	false	A zipcode	02101
_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
_dateOfBirth	string	false	A person's date of birth A UTC date in the ISO-8601 format	2007-12-20
_degree	string	false	An caregiver's name Values:MEDICAL_DOCTOR,DOCTOR_OF_OSTEOPATHY,PHYSICIAN_ASSISTANT,REGISTERED_NURSE,CLINICAL_NURSE_SPECIALISTS,NURSE_PRACTITIONER,LICENSED_PRACTICAL_NURSE,MEDICAL_ASSISTANT,NO_DEGREE,OTHER	PHYSICIAN_ASSISTANT
_description	string	false	A description, can be up to 5000 characters long	Lorem Ipsum
_email	string	false	An email address in the RFC-5322 specification	[email protected]
_employeeId	string	false
_gender	string	false	A persons gender Values:MALE,FEMALE,UNDISCLOSED	FEMALE
_locale	string	false	A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
_mfa	object	false
_mfa.enabled	boolean	false	MFA login enabled or disabled. When omitted, the template's configured default is applied.
_mfa.expirationInMinutes	integer	false	MFA expiration time in minutes
_name	object	true
_name.firstName	string	true(*)	A person's first name	John
_name.lastName	string	true(*)	A person's last name	Smith
_ownerOrganization	object	true
_ownerOrganization.id	string	true(*)
_password	string	true	A password	Aa123456
_phone	string	false	A person's phone An E.164 formatted phone number	+12345678901
_username	string	true	User's username. Can be an email or a regular username. With this username you login to the system.	[email protected] or john123
Path Parameters:

Parameter	Type	Mandatory	Description	Example
templateName	string	true	null

This API requires PROTECTED_API permission(s).

Path Params

templateName

string

required

Body Params

_name

object

required

_description

string

A description, can be up to 5000 characters long

_email

string

An email address in the RFC-5322 specification

_phone

string

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

_locale

string

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

_gender

string

enum

A persons gender

Allowed:

_dateOfBirth

string

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

_address

object

_mfa

object

_credentialType

string

enum

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

Allowed:

_employeeId

string

_degree

string

enum

An caregiver's name

_username

string

required

User's username. Can be an email or a regular username. With this username you login to the system.

_password

string

required

A password

_ownerOrganization

object

required

Responses

Parameter	Type	Description	Example
<customAttribute1>	<customAttribute1Type>	Regular custom attribute 1 value
<customAttributeN>	<customAttributeNType>	Regular custom attribute N value
_address	object
_address.address1	string	An address	11 Main St.
_address.address2	string	An address's specifics	Entry B, Apartment 1
_address.city	string	A city	Boston
_address.countryCode	string	A 2-letter country code defined in ISO-3166	US
_address.state	string	A state	Massachusetts
_address.zipCode	string	A zipcode	02101
_caption	string
_creationTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_credentialType	string	What type of credentials is used when logging in to the system. Only one type can be used. Default:PASSWORD Values:PASSWORD,OTP
_dateOfBirth	string	A person's date of birth A UTC date in the ISO-8601 format	2007-12-20
_degree	string	An caregiver's name Values:MEDICAL_DOCTOR,DOCTOR_OF_OSTEOPATHY,PHYSICIAN_ASSISTANT,REGISTERED_NURSE,CLINICAL_NURSE_SPECIALISTS,NURSE_PRACTITIONER,LICENSED_PRACTICAL_NURSE,MEDICAL_ASSISTANT,NO_DEGREE,OTHER	PHYSICIAN_ASSISTANT
_description	string	A description, can be up to 5000 characters long	Lorem Ipsum
_email	string	An email address in the RFC-5322 specification	[email protected]
_employeeId	string
_enabled	string	Is the user enabled Values:DISABLED,ENABLED	ENABLED
_gender	string	A persons gender Values:MALE,FEMALE,UNDISCLOSED	FEMALE
_id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_invitationAccepted	boolean	Has invitation been accepted
_lastModifiedTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
_locale	string	A person's locale Locale in the following format: {language-ISO639}-{countryCode-ISO3166} lowercase.	en-us
_mfa	object
_mfa.enabled	boolean	MFA login enabled or disabled. When omitted, the template's configured default is applied.
_mfa.expirationInMinutes	integer	MFA expiration time in minutes
_name	object
_name.firstName	string	A person's first name	John
_name.lastName	string	A person's last name	Smith
_ownerOrganization	object
_ownerOrganization.id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.name	string	The caption of the referenced entity
_ownerOrganization.organizationId	string	The id of the organization of the referenced entity.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.parentEntityId	string	The id of the parent entity (appears only for child entities)
_ownerOrganization.template	object
_ownerOrganization.template.displayName	string	The display name of the template
_ownerOrganization.template.id	string	The id of the template
_ownerOrganization.template.name	string	The name of the template
_ownerOrganization.template.parentTemplate	object
_ownerOrganization.template.parentTemplate.displayName	string
_ownerOrganization.template.parentTemplate.id	string
_ownerOrganization.template.parentTemplate.name	string
_ownerOrganization.templateId	string	The id of a template that is configured in the settings service.	3fa85f64-5717-4562-b3fc-2c963f66afa6
_ownerOrganization.templateName	string	The name of the referenced entity template
_phone	string	A person's phone An E.164 formatted phone number	+12345678901
_referencers	object	An object that contains all the referencers of this entity. Each referencer is the RSAN and it's an object that contains the count of the referrers, and information of the referrer (in case count = 1)
_template	object
_template.displayName	string	The display name of the template
_template.id	string	The id of the template
_template.name	string	The name of the template
_template.parentTemplate	object
_template.parentTemplate.displayName	string
_template.parentTemplate.id	string
_template.parentTemplate.name	string

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401Code : TOKEN_NOT_VALID, Details: []

404Code : ORGANIZATION_NOT_FOUND, Details: [id] Code : TEMPLATE_NOT_FOUND_BY_NAME, Details: [templateName] Code : REFERENCE_CONFIGURATION_ENTITY_NOT_FOUND, Details: [attributeName, entityId]

409Code : EMAIL_ALREADY_EXIST, Details: [email] Code : USERNAME_ALREADY_EXIST, Details: [username, userId] Code : PHONE_NUMBER_IS_USED, Details: [phoneNumber]

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []