Create an HCM User

post

https://api.avionte.com/front-office/v1/user

Creates an HCM User record that will allow a user to be able to log into Bold.

Body Params

firstName

string

required

length ≤ 255

The user's first name.

lastName

string

required

length ≤ 255

The user's last name.

emailAddress

string

required

length ≤ 255

The user's primary email address.

homePhone

string

length ≤ 255

The user's home phone number.

workPhone

string

length ≤ 255

The user's work phone number.

mobilePhone

string

length ≤ 255

The user's mobile phone number.

faxPhone

string

length ≤ 255

The user's fax phone number.

street1

string

length ≤ 255

Street address, line 1.

street2

string

length ≤ 255

Street address, line 2.

city

string

length ≤ 255

City.

stateProvince

string

length ≤ 2

ISO 2-character code for the Province, State, or Region.

postalCode

string

length ≤ 50

ZIP/postal code.

country

string

length ≤ 2

A 2-letter ISO 3166-1 alpha-2 code representing the country (e.g., "US", not "USA"). For details, see the General Guidelines.

homeOfficeId

int32

required

The identifier of the user's home office.

officeAccess

array of int32s

A list of office IDs that the user has access to.

officeAccess

userTypeId

int32

required

The identifier for the user type of the user.

userGroups

array of int32s

A list of user group IDs to which the user belongs.

userGroups

sendWelcomeEmail

boolean

An indication of whether to send a welcome email to the user upon creation. This will default to false if not provided.

Headers

RequestId

uuid

Unique request identifier (GUID) used to correlate request data with log entries and events.

FrontOfficeTenantId

integer

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenant

string

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Responses

401

Unauthorized

403

Access Denied

405

Unsupported method

406

Unsupported format(s) indicated by Accept header

409

Operation could not be completed due to conflict.

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

504

Gateway Timeout

201The HCM User that was successfully created.

400Bad Request

404Not found