UpdateUsers, ImportUsers, UpdateOnPremUsers, ImportOnPremUsers: Update/Create users from a file.

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
<ImportUsers/>


Tag: UpdateOnPremUsers

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


XML
<UpdateOnPremUsers/>

Tag: ImportOnPremUsers

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


XML
<ImportOnPremUsers/>


Tag Attributes

Attributes

Attribute Value

Value Description

FilePath

N/A

Input file path

SkipRows

N/A

Integer (defaults to 0) - The number of rows to skip in input file, up to 10 (arbitrary value).

HasHeaders

TRUE / FALSE (Defaults to TRUE) - Whether the file has column headers or not

N/A

SkipValue

N/A

Cell value to be interpreted as 'do nothing here'. Nothing is skipped if this is missing - Optional

KeyField

N/A

[Update only] name of field used for row matching

KeyValue

N/A

[Update only] index of column used for row matching (see doc below)

MailboxType

regular/Equipment/Shared/Room

[ImportUsers only] regular/Equipment/Shared/Room

CheckDuplicates

TRUE / FALSE (Defaults to TRUE) - Search the grid for existing objects (and skip them)

[ImportUsers, ImportGroup, ImportOnPremUsers, ImportOnPremGroups] 

PrefillWithSelection

TRUE / FALSE (Defaults to TRUE) - Use the current selection to prefill new objects

[ImportUsers, ImportGroup, ImportOnPremUsers, ImportOnPremGroups]

onPremDomain

Domain name

[ImportOnPremUsers only] Domain for all the imported users, instead of a file column.

onPremOU

Organizational unit

[ImportOnPremUsers only] Organizational unit for all the imported users, instead of a file column. Needs onPremDomain.


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>