Exporting users and groups¶

Exports of the UserManagement type contain an overview of the users and groups that have been created in the User Management module.

The export can be output either as an XML or JSON file.

In addition to the keys described in the Parameter file section, the parameter file can also contain the following keys specifically for this export.

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¶

VDogAutoExport.exe "/rd:D:\vdClientArchive" "/CFile:D:\Test\UserManagement.ini"

Parameter file UserManagement.ini¶

[Common]
ReportType=UserManagement
ExportFile=D:\Test\Users.xml
UmGroupedBy="Users"

[User]
Account={User}
Password={Password}

Overview of the attributes that can occur in the resulting file¶

Element root¶

The <root> element is the starting point of the list.

Element Users¶

The <Users> element encloses the user information. This element is only output if the key UmGroupedBy in was transferred to the parameter file with the value users.

Element	Attribute	Description
`<User>`	Admin="..."	Specifies whether the user has administrative rights.
`<User>`	Phone="..."	Contains the user's telephone number.
`<User>`	EmailAddress="..."	Contains the user's email address.
`<User>`	FullName="..."	Contains the user's full name.
`<User>`	Domain="..."	Specifies the domain in which the user was created.
`<User>`	LastEditedLocal="..."	Time of the last changes to the user (local time)
`<User>`	LastEditedUTC="..."	Time of the last changes to the user (UTC)
`<User>`	ID="..."	Contains the unique ID of the user (in GUID format).
`<User>`	Comment="..."	Contains the comment for the user.
`<User>`	Name="..."	Contains the user name.

Element 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.

Element	Attribute	Description
`<Usergroup>`	LastEditedLocal="..."	Time of the last changes to the group (local time)
`<Usergroup>`	LastEditedUTC="..."	Time of the last changes to the group (UTC).
`<Usergroup>`	ID="..."	Contains the unique ID of the group (in GUID format).
`<Usergroup>`	Comment="..."	Contains the comment for the group.
`<Usergroup>`	Name="..."	Contains the name of the group.

Parameter file