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


Input (addUserParam)

Name Type Required Description
*firstName* xsd:string Yes The user’s first name.
*lastName* xsd:string Yes The user’s last name.
*email* xsd:string Yes The user’s email address.
*defaultRole* xsd:string Yes Sets the role for a user in each company they belong to. Note, however, the IpsAdmin role overrides other per-company settings.
*password* xsd:string Yes Sets the user’s password
*passwordExpires* xsd:dateTime No Sets the password expiration period. Provide the time zone when passing in the request. Time zones are adjusted to Central Time.
*isValid* xsd:boolean Yes Determines if the user is valid.
*membershipArray* xsd:CompanyMembershipUpdateArray Yes An array of company handles.

Output (addUserParam)

Name Type Required Description
*userHandle* xsd:string Yes The handle to the user.


The IPS API returns a user handle element that specifies the new user.


<ns1:addUserParam xmlns:ns1="">


<ns1:addUserReturn xmlns:ns1="">

On this page