ClientUserList Method (String) |
Returns a List of users in the specified organization.
Namespace: MOVEit.DMZ.APIAssembly: MOVEit.DMZ.API (in MOVEit.DMZ.API.dll) Version: 9.0.0.0
Syntax public List<MOVEitUserInfo> UserList(
string OrgID
)
Public Function UserList (
OrgID As String
) As List(Of MOVEitUserInfo)
public:
List<MOVEitUserInfo^>^ UserList(
String^ OrgID
)
Parameters
- OrgID
- Type: SystemString
ID of the organization to list the users of.
Return Value
Type:
ListMOVEitUserInfoList containing list results if successful; otherwise,
null.
Remarks
Returns an empty List if no users are found or
if the currently
authorized user is not permitted to get this information. The
OrgID argument only
applies if the currently authorized user is a SysAdmin; by default this value is the
same as the currently authorized user's OrgID.
NOTE: MOVEit Transfer enforces a 1000 entry limit on the number of users that
can be returned from a single listing, for performance reasons. If you need to list
more than 1000 users, please use the
UserListAdvanced(Int32, Int32, ClientUserPermissionFilter, ClientUserStatusFilter, String, ClientUserSearchStringFilter, String, String)
function.
To determine if there are more than 1000 users on the system, check
the UserListCount value after this function returns. It will contain
the total number of users available to the current user.
See Also