DocumentationDynamic Media Image Production System API

addUser

Last update: Wed Mar 09 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

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)

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.

Examples

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

Request

<ns1:addUserParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:firstName>Joe</ns1:firstName>
   <ns1:lastName>User</ns1:lastName>
   <ns1:email>juser@adobe.com</ns1:email>
   <ns1:defaultRole>TrialSiteUser</ns1:role>
   <ns1:password>passw0rd</ns1:password>
   <ns1:isValid>true</ns1:isValid>
   <ns1:companyHandleArray>
      <ns1:items>47</ns1:items>
   </ns1:companyHandleArray>
</ns1:addUserParam>

Response

<ns1:addUserReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:userHandle>525s|juser@scene7.com</ns1:userHandle>
</ns1:addUserReturn>
4e9b9d8c-5839-4215-aa35-01b652869681