Enumerating users in JSON-RPC API
You can get the list of users of your own company and your customers using the EnumerateUsers
method.
Required parameters
Parameter | Description | Supported values |
---|---|---|
partnerIds
|
The ID of the customer the users are created for (retrieved through the |
<int> Integer in array format e.g. [partnerIds1,partnerIds2] |
Sample request
{ "jsonrpc":"2.0", "visa": "{{visa}}", "id":"jsonrpc", "method" : "EnumerateUsers", "params" : { "partnerIds" : [123456] } }
Sample response
{ "id": "jsonrpc", "jsonrpc": "2.0", "result": { "result": [ { "EmailAddress": "user1@demodomain.com", "FirstLoginTime": 1530020135, "FirstName": "User1", "Flags": [ "SecurityOfficer", "AllowApiAuthentication" ], "FullName": "Demo", "Id": 765432, "LastLoginTime": 1573030172, "Name": "user1@demodomain.com", "PartnerId": 123456, "Password": null, "PhoneNumber": "", "RoleId": 1, "Title": "End-User", "TwoFactorAuthenticationStatus": "Disabled" }, { "EmailAddress": "user2@demodomain.com", "FirstLoginTime": 1541777548, "FirstName": "User2", "Flags": [ "AllowApiAuthentication" ], "FullName": "Demo", "Id": 654321, "LastLoginTime": 1541777548, "Name": "user2@demodomain.com", "PartnerId": 123456, "Password": null, "PhoneNumber": "", "RoleId": 1, "Title": "End-User" } ] }, "visa": "{{visa}}" }