User Object

The User object represents a RocketCOMS Portal user.

Attributes

string (UUID)

Unique ID assigned to the user in RocketCOMS.

firstName

string

User’s first name.

title

string

User’s title. (Examples: Mr., Mrs., Dr., Ms.)

signatory

boolean

Whether the user is an authorized signatory for the Business Account.

lastName

string

User’s last name.

middleName

string

User’s middle name.

string

User’s email address.

mobileNumber

string

User’s mobile number.

role

string, values: BA_ADMIN, BA_MANAGER

User’s role in the RocketCOMS Portal. Possible values are:

BA_ADMIN Business Account Administrator. Administrators can perform all actions in the Portal.
BA_MANAGER Business Account Manager. Managers can perform all actions in Portal except create users and delete users.

businessAccount

object

Details for the Business Account that the user belongs to. For details, see the Business Account object.

address

object

User’s address. For details, see the Address object.

passwordUpdated

boolean

Whether the user’s password has been updated.

deletedAt

string (date-time)

Date and time the user was deleted from the RocketCOMS Portal.

isEnabled

boolean

Whether the user’s access to the RocketCOMS Portal is active.

isAccountExpired

boolean

Whether the user’s access to the RocketCOMS Portal is expired.

createdAt

string (date-time)

Date and time the user was created in the RocketCOMS Portal.

updatedAt

string (date-time)

Date and time the user was last updated in the RocketCOMS Portal.

User Object

				
					{
  "id": "d7b0e25f-30c9-456b-b287-6b3dcaa4b8f7",
  "firstName": "John",
  "title": "Mr.",
  "signatory": true,
  "lastName": "Doe",
  "middleName": "Allan",
  "email": "abc@business.com",
  "mobileNumber": "+15555551234",
  "role": "BA_MANAGER",
  "businessAccount": {...},
  "address": {...},
  "passwordUpdated": true,
  "deletedAt": "2022-04-28T16:51:03.419Z",
  "isEnabled": false,
  "isAccountExpired": false,
  "createdAt": "2022-04-24T16:51:03.419Z",
  "updatedAt": "2022-04-26T16:51:03.419Z"
}