addUser

Last update: March 9, 2022

CREATED FOR:

  • Developer
  • Admin

Creates a user account and adds that account to one or more companies.

When adding a user to multiple companies, specify those companies by their company handles in companyHandleArray. This operation returns the handle to user you just added.

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

Parameters

Input (addUserParam)

NameTypeRequiredDescription
firstNamexsd:stringYesThe user’s first name.
lastNamexsd:stringYesThe user’s last name.
emailxsd:stringYesThe user’s email address.
defaultRolexsd:stringYesSets the role for a user in each company they belong to. Note, however, the IpsAdmin role overrides other per-company settings.
passwordxsd:stringYesSets the user’s password
passwordExpiresxsd:dateTimeNoSets the password expiration period. Provide the time zone when passing in the request. Time zones are adjusted to Central Time.
isValidxsd:booleanYesDetermines if the user is valid.
membershipArrayxsd:CompanyMembershipUpdateArrayYesAn array of company handles.

Output (addUserParam)

NameTypeRequiredDescription
userHandlexsd:stringYesThe handle to the user.