Import a CSV file that contains data for multiple users.

 

User Import Operation allows Create, Update and Delete of existing users using UserName

​

Prerequisites

• Your unique Tenant ID, obtained from support.
• Your unique apiKey, as generated in Company Info.
• A CSV file containing user data
  • One record per row
  • The first row should contain column headings.
     (That row is ignored during import.)
• Use the File Upload API to upload the CSV file to Pulpstream.
  That process gives you a file reference to use in this API.
  

Details

​

Method: POST

URL: https://us.pulpstream.com/vfr/api/imports/User

Headers:

tenantId: {tenantId}

apiKey: {apiKey}

Content-Type: application/json

apiUserName: Optional. Specify internal username from the User definition to submit the data on behalf of that user.

 

PayLoad:

{"file":"5ff0569da3fb4a309a2ca38eb9073222_Users.csv",    // The reference obtained from the File Upload API

 "fieldMapList":[{"column":"0","objectField":"firstName"},
                 {"column":"1","objectField":"lastName"},
                 {"column":"2","objectField":"userName"},
                 {"column":"3","objectField":"businessUnit"},
                 {"column":"4","objectField":"emailAddress"},
                 {"column":"5","objectField":"supervisorId"},
                 {"column":"6","objectField":"profileId"},
                 {"column":"7","objectField":"ssoUser"},

                 {"column":"8","objectField":"locationId"},

                 {"column":"9","objectField":"secondaryLocations"},

                 {"column":"11","objectField":"employeeId"},
                 {"column":"12","objectField":"active"},
                 {"column":"13","objectField":"site"},
                 {"column":"14","objectField":"state"},
                 ...
                ]
}

 

   Notes:

• The field map list is an array of pairs, where each item in the pair is itself a name/value pair.
  • The first pair is the literal "column", with a column-number value.
  • The second pair is the literal "objectField". 
    The value is the name of the field to receive the data in that column.
• As with all CSV files, the first row should be a title row that contains column headings.
  That row is ignored on import.
• When the import finishes, an email is sent to the user specified in the apiUserName parameter.
  If that parameter is not present, the email goes to the designated administrators in the
  general Company Information settings.
  

Mappable Fields
These fields are available for mapping. (The internal field names are shown in parentheses.)

• First Name (firstName) - required
• Last Name (lastName) - required
• Email Address (emailAddress) - required
  • If the address matches an existing user, new data is merged into that user's record.
    
• User Name (userName) - required (Can be same as email address)
• Time Zone (timeZone) (If this is not sent, the time zone will be set to Company Time Zone)
  • Default is the time zone specified in Company Information.
  • These time zone values are recognized:
    • America/Los_Angeles
    • America/Chicago
    • America/Denver
    • America/New_York
• Profile Id (profileId) - The Profile that will be assigned to user. If this is not supplied, user will be assigned 'Regular User' profile
• Supervisor User Name (supervisorId) - This will be User ID or User Name of the Supervisor
  
• Department (department)
• Business Unit (businessUnit)
• Phone (phone)
• City (site)
• State (state)
• Country (country)
• Active (active) - Send it as 0 or 1. If it is 1, Users will be sent welcome email, if 0 and user is existing then it will be inactivated
• Employee Id (employeeId)
• Primary Group Id - (locationId) - The Group or Business Unit ID of the user
• Secondary Groups Id - (secondaryLocations) - Comma Separated IDs of Secondary Groups, the User belongs to
• Password (password) - An optional temporary password can be specified. If no password is specified, a temporary password is generated
• SSO User (ssoUser) - Set this value to 1 if single sign-on has been enabled for your account and the user being imported will be authenticated using that mechanism.  
• Delete Flag (deleteFlag) - This value can be set to 1 for those users that needs to be deleted. Users will be immediately removed from the system. Any tasks owned by them would need to be manually transformed to other users.