Exporting users and groups
The export contains an overview of the users and groups that have been created in the User Management module.
In addition to selecting the export format and CSV separator, you can configure what content should be included in the export.
- If the results should be grouped by users or groups
- If the users that have already been deleted from the system, should be exported
Settings for the ExportModule
In addition to the keys described in the Parameter file section, the parameter file can also contain the following keys specifically for this export.
Section Common
| Key | Description | Values |
|---|---|---|
| UmGroupedBy | Specifies whether to group by user or by group. | - Users: It is grouped by users. - Groups: It is grouped by groups (default value). |
| IncludeDeletedUsers | Specifies whether users that have already been deleted from the system are listed during export. | - Y: Users that have already been deleted are also exported. - N: Users that have already been deleted are not exported (default value) |
Example call
Parameter file UserManagement.ini
[Common]
ReportType=UserManagement
ExportFile=D:\Test\Users.xml
UmGroupedBy="Users"
[User]
Account={User}
Password={Password}
Output file
The export can be generated in either XML or JSON format, depending on your selected output option.
The XML output file contains the following elements:
root:
The <root> element is the starting point of the list.
Users:
The <Users> element encloses the user information. This element is included in the output only if the key UmGroupedBy is set to users in the parameter file.
User:
| Attribute | Description |
|---|---|
| Admin="..." | Specifies whether the user has administrative rights. |
| Phone="..." | Contains the user's telephone number. |
| EmailAddress="..." | Contains the user's email address. |
| FullName="..." | Contains the user's full name. |
| Domain="..." | Specifies the domain in which the user was created. |
| LastEditedLocal="..." | Time of the last changes to the user (local time) |
| LastEditedUTC="..." | Time of the last changes to the user (UTC) |
| ID="..." | Contains the unique ID of the user (in GUID format). |
| Comment="..." | Contains the comment for the user. |
| Name="..." | Contains the user name. |
Usergroups:
The <Usergroups> element encloses the information on the groups. This element is only output if the key UmGroupedBy was transferred in the parameter file with the value Groups.
Usergroup:
| Attribute | Description |
|---|---|
| LastEditedLocal="..." | Time of the last changes to the group (local time) |
| LastEditedUTC="..." | Time of the last changes to the group (UTC). |
| ID="..." | Contains the unique ID of the group (in GUID format). |
| Comment="..." | Contains the comment for the group. |
| Name="..." | Contains the name of the group. |
Related topics