Create User

Create a new user and associate the account with one or more client accounts.

SecurityApiKeyAuth
Request
header Parameters
IV
required
string

Initialization Vector for database encryption.

Request Body schema:
firstName
required
string (FirstName) <= 30 characters

First name of user.

lastName
required
string (LastName)

Last name of user.

timezone
string (Timezone)

The time zone of the client application.

Enum: "Pacific Time - 01:00 am - UTC-7" "Arizona Time - 01:00 am - UTC-7" "Mountain Time - 02:00 am - UTC-6" "Central Time - 03:00 am - UTC-5" "Eastern Time - 04:00 am - UTC-4" "Hawaii Time - 10:00 pm - UTC-10" "Alaska Time - 00:00 am - UTC-8"
isMfaActive
boolean (IsMfaActive)

Is Multi-Factor Authentication enabled.

isUserActive
boolean (IsUserActive)

Is the User account active.

isUserLocked
boolean (IsUserLocked)

Is the user account locked.

required
Array of objects (EmailAddressesArray)

Array containing email addresses.

Array
email
required
string <email>

Email address.

label
required
string

Label indicating type of email address (e.g., work, personal)

primary
required
boolean

True or false value indicating if email address is the primary email address for the account. Primary email addresses are used for user communication and are one option for user Login credentials (with phone number)

required
Array of objects (PhoneNumbersArray)

An array of phone numbers.

Array
phoneNumber
required
string

Phone number.

label
required
string

Label indicating type of phone number (e.g., work, personal)

primary
required
boolean

True of false value indicating if phone number is the primary phone number for the account. Primary phone numbers are used for user communication and are one option for user Login credentials (with email address).

required
Array of objects (UserRolesByClient)

An array indicating the user's assigned roles by client.

Array
clientId
string <UUID>

Unique identifier for the client.

clientName
string

The name of the client (DBA).

userRoles
string

The roles assigned to the user for a specific client account.

Enum: "Admin" "Merchant" "Agent" "Support" "View"
Responses
201

User created successfully.

400

Bad Request

401

Unauthorized access

403

Access forbidden

409

Conflict.

429

Too Many Requests

post/users
Request samples
{
  • "firstName": "Leonard",
  • "lastName": "Smith",
  • "timezone": "Pacific Time - 01:00 am - UTC-7",
  • "isMfaActive": true,
  • "isUserActive": true,
  • "isUserLocked": false,
  • "emailAddresses": [
    ],
  • "phoneNumbers": [
    ],
  • "userRolesByClient": [
    ]
}
Response samples
{
  • "userId": "8fffb4e6-6661-41fe-9511-20aad576c574",
  • "firstName": "Leonard",
  • "lastName": "Smith",
  • "timezone": "Pacific Time - 01:00 am - UTC-7",
  • "isMfaActive": true,
  • "isUserActive": true,
  • "isUserLocked": false,
  • "emailAddresses": [
    ],
  • "phoneNumbers": [
    ],
  • "userRolesByClient": [
    ],
  • "sessionDetails": {
    }
}
Copyright © Pace Software 2021–2023. All rights reserved.