UserAccountModel

A User represents a person who has the ability to authenticate against the Lockstep Platform and use
services such as Lockstep Inbox. A User is uniquely identified by an Azure identity, and each user must
have an email address defined within their account. All Users must validate their email to make use of
Lockstep platform services. Users may have different privileges and access control rights within the
Lockstep Platform.

Methods

The following API methods use this data model.

Read-Only Fields

These fields are assigned by the API server and cannot be changed.

userId

uuid, read-only

The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Lockstep platform.

This record provides a link to the user's Azure AD B2C OID.

groupKey

uuid, nullable, read-only

The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

email

email, read-only, 0-99 characters

The email of the user

created

date-time, read-only

The date that the user account was created

createdUserId

uuid, read-only

The ID of the user who created the user account

modified

date-time, read-only

The date the user account was last modified

modifiedUserId

uuid, read-only

The ID of the user who last modified the user account

modifiedUserName

string, nullable, read-only

The name of the user who last modified the user account

b2CUserId

uuid, nullable, read-only

The ID of the user in Azure B2C

inviteSent

date-time, nullable, read-only

The date timestamp when the invite was sent to the user.

b2CLastLoggedIn

date-time, nullable, read-only

Last date time user logged into Azure B2C.

Required Fields

userName

string, 1-99 characters

The full name of the user

userRole

uuid

The id of the Permission Level for the user.

Optional Fields

status

string, nullable, 0-40 characters

The status of the user's account

phoneNumber

string, nullable, 0-20 characters

The phone number of the user.

faxNumber

string, nullable, 0-20 characters

The fax number of the user.

title

string, nullable, 0-40 characters

The title of the user; free text field

accountingRoleCodeDefId

uuid, nullable

FK to the CodeDefinition table; CodeType = 'AccountingRole'

address1

string, nullable, 0-100 characters

Address Line 1 for this User

address2

string, nullable, 0-100 characters

Address Line 2 for this User

address3

string, nullable, 0-100 characters

Address Line 3 for this User

city

string, nullable, 0-100 characters

City for this User

stateRegion

string, nullable, 0-100 characters

Region ("state" in the US) for this User

postalCode

string, nullable, 0-100 characters

Postal Code this User

country

string, nullable, 2-2 characters

Country for this User This will be validated by the /api/v1/definitions/countries data set

timeZone

string, nullable, 0-40 characters

Time zone for this user

imageURL

string, nullable, 0-500 characters

Image URL for this User

description

string, nullable, 0-512 characters

Description for this User.

defaultCurrencyCode

string, nullable, 0-3 characters

The default currency code used by this user entity. This value can be overridden
for invoices in a different currency code.

For a list of defined currency codes, see Query Currencies This will be validated by the /api/v1/definitions/currencies data set

Included Collections

These fields are available when using Retrieve or Query API calls if you specify the associated Include parameter.

notes

NoteModel[], nullable, read-only

A collection of notes linked to this record. To retrieve this collection, specify Notes in the
include parameter when retrieving data.

To create a note, use the Create Note
endpoint with the TableKey to UserAccount and the ObjectKey set to the UserId for this record. For
more information on extensibility, see linking extensible metadata to objects.

attachments

AttachmentModel[], nullable, read-only

A collection of attachments linked to this record. To retrieve this collection, specify Attachments in
the include parameter when retrieving data.

To create an attachment, use the Upload Attachment
endpoint with the TableKey to UserAccount and the ObjectKey set to the UserId for this record. For
more information on extensibility, see linking extensible metadata to objects.

customFieldValues

CustomFieldValueModel[], nullable, read-only

A collection of custom fields linked to this record. To retrieve this collection, specify
CustomFieldValues in the include parameter when retrieving data.

To create a custom field, use the Create Custom Field
endpoint with the TableKey to UserAccount and the ObjectKey set to the UserId for this record. For
more information on extensibility, see linking extensible metadata to objects.

accountingRoleCodeDefinition

CodeDefinitionModel, nullable, read-only

Accounting role definition for this User.
To retrieve this collection, specify AccountingRole in the "Include" parameter for your query.


Did this page help you?