Method GetAllUsersSimple

GetAllUsersSimple(String, UserFilterContract)

Get all users simple information of this server

Declaration

UserSimpleResultContract GetAllUsersSimple(string connectionId, UserFilterContract userFilter)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
UserFilterContract	userFilter	User filter See also UserFilterContract Default configuration for userFilter: RemoveDeletedUsers = false, RemoveInactiveUsers = true

Returns

Type	Description
UserSimpleResultContract	Get all users simple

Examples

POST http://YourServerName/InfoShare/Json/Common/GetAllUsersSimple

Example for getting all users simple information of this server.

{
   "connectionId": "b6742bb8-ef97-44ae-819b-a2fa2200908a",
   "userFilter": {
     "RemoveDeletedUsers": true,
     "RemoveExternalLicenseUsers": false,
     "RemoveHiddenUsers": true,
     "RemoveInactiveUsers": true 
   }
}

Response:

{
   "GetAllUsersSimpleResult": {
     "ActiveUsers": [{
       "DisplayName": "DCI administrator",
       "ExternalUser" : False,
       "HiddenInUI": False,
       "Id": "0100a003-38a7-11d8-a902-0050bf427e8f",
       "LoginName": "dciadmin",
       }, {
       "DisplayName": "Mario test",
       "ExternalUser" : False,
       "HiddenInUI": False,
       "Id": "3ebeaea0-e654-11df-a2ff-001b24b38155",
       "LoginName": "net",
       }, {
       "DisplayName": "Andreas test",
       "ExternalUser" : False,             
       "HiddenInUI": False,
       "Id": "136b7f23-e810-11df-8f25-000c29bbc049",
       "LoginName": "dob",
       }, {
       "DisplayName": "spi",
       "ExternalUser" : False,
       "HiddenInUI": False,
       "Id": "63a7dd26-eb53-11df-b40a-005056c00008",
       "LoginName": "spi",
       }, { ... }]
     "InactiveAndObsoleteUsers": [],
     "SessionCount": 135
   }
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Verification code is needed: Verification code not yet verified (10152)
ServiceException	Two way authentication type ({twoWayAuthenticationType}) is invalid. Valid types are: {allowedTwoWayAuthenticationTypes} (10148)
ServiceException	Could not parse int {flag} to a valid two way authentication type (10154)