Login
      Contents x
      Users
      • 24 Jul 2024
      • Print
      • PDF
      Contents

      Users

      • Updated on 24 Jul 2024
      • Print
      • PDF
      Article summary

      Description 

      Information associated with a user.

      Resource Overview 

      Endpoint Definition 
      GET/UsersRetrieve a list of users and associated information.
      POST/UsersAdd a user. 
      PUT/Users
      		Modify existing users.

      Attributes

      Attribute
      Description
      Data Type
      Notes 
      UserID
      		unique identifier for the user
      		integer

      AllBranchAccess
      		indicates if the user has access to all branchesboolean

      BranchAccess      		list of the user's associated branch accesslist of integer, string

      ExternalContactReference
      		name of the external contact's reference.string

      ContactFirstName
      		first name of user contactstring

      ContactLastName
      		last name of user contactstring


      Active
      		indicates if the user is activeboolean

      UserRoles
      		list of the user's role names and unique identifier of the roleslist of integer, string
      Was this article helpful?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.
      Logout