Skip to main content
Skip table of contents

Update/Import Users

Tag: UpdateUsers

The UpdateUsers function updates selected cloud users within the grid.


XML
<UpdateUsers/>

Tag: ImportUsers

The ImportUsers function imports cloud users within the grid from selected file.


XML
<UpdateOnPremUsers/>

Tag: UpdateOnPremUsers

The UpdateOnPremUsers function updates selected on premise users within the grid.


XML
<UpdateOnPremUsers/>

Tag: ImportOnPremUsers

The ImportOnPremGroups function imports on premise users within the grid from selected file.


XML
<ImportOnPremUsers/>


Tag Attributes

AttributesAttribute ValueValue Description
FilePathN/AInput file path
SkipRowsN/AInteger (defaults to 0) - The number of rows to skip in input file, up to 10 (arbitrary value).
HasHeadersTRUE / FALSE (Defaults to TRUE) - Whether the file has column headers or notN/A
SkipValueN/ACell value to be interpreted as 'do nothing here'. Nothing is skipped if this is missing - Optional
KeyFieldN/A[Update only] name of field used for row matching
KeyValueN/A[Update only] index of column used for row matching (see doc below)
MailboxTyperegular/Equipment/Shared/Room[ImportUsers only] regular/Equipment/Shared/Room
CheckDuplicatesTRUE / FALSE (Defaults to TRUE) - Search the grid for existing objects (and skip them)[ImportUsers, ImportGroup, ImportOnPremUsers, ImportOnPremGroups] 
PrefillWithSelectionTRUE / FALSE (Defaults to TRUE) - Use the current selection to prefill new objects[ImportUsers, ImportGroup, ImportOnPremUsers, ImportOnPremGroups]

Column mapping works the same as for 'Select / Filter from file'. If not column mapping is specified, default mapping (the one you see if you do the action manually) is used.

For ImportUsers, "forceChangePasswordNextSignIn" and "forceChangePasswordNextSignInWithMfa" can be set using setParam.

Example Script

XML
		<ImportUsers FilePath="shark-1800-Shared.xlsx" HasHeaders="True" SkipRows="0" SkipValue="(-n/s-)" keepalive ="false" CheckDuplicates='true' MailboxType="Shared" >
			<SetParam field="displayName" value= "0" />
			<SetParam field="userPrincipalName" value= "1" />
			<SetParam field="userType" value= "2" />
			<SetParam field="mail" value= "9" />
			<SetParam field="mailNickname" value= "10" />
			<SetParam field="MAILBOXTYPE" value= "26" />
		</ImportUsers>





JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.