getAccountsList
You can use this method to display all the user accounts that belong to a company.
Only accounts visible to the account which has generated the API key are returned. An empty list is returned if there are no user accounts that match the request parameters.
Note
When the accounts list is retrieved, the account which generated the API key will be omitted.
Parameters
Parameter | Type | Optional | Description |
|---|---|---|---|
| Number | Yes | The results page number. Default value: |
| Number | Yes | The number of items displayed in a page. Possible values: Default value: |
Return value
This method returns an Object containing information regarding user accounts. The returned object contains:
Attribute | Type | Description |
|---|---|---|
| Integer | The page currently displayed. |
| Integer | The total number of pages available. |
| Integer | The number of items displayed per page. |
| Object | A list of user accounts. |
| String | The ID of the user account. |
| String | The email address associated to the user account. |
| Object | A list of attributes containing user account information |
| String | The name associated with the user account. |
| String | The timezone associated with the user account. |
| String | The language associated with the user account. |
| String | The page where the user is directed after logging in to GravityZone. |
| Integer | Indicates the role assigned to the user account. Possible values:
|
| Object | A list of attributes indicating what rights are assigned to the user. Possible values for each attribute:
NoteYou can find a list of rights and what access each one provides under createAccount. |
| Integer | Indicates the password expiration policy assigned to the user account. Possible values:
Default value: |
| Boolean | If |
| Boolean | if true, indicates that Two Factor Authentication (2FA) is activated for the user account. |
| String | The name of the company the user account belongs to. |
| String | The ID of the company the user account belongs to. |
| Integer | The number of items returned by the request. |
Example
Request :
{
"id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
"jsonrpc": "2.0", "method": "getAccountsList",
"params": {
"perPage": 20,
"page": 1
}
} Response :
{
"id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
"jsonrpc": "2.0",
"result": {
"total": 2,
"page": 1,
"perPage": 20,
"pagesCount": 1,
"items": [
{
"id": "585d3170aaed70b7048b4633",
"email": "[email protected]",
"profile": {
"fullName": "Bitdefender User",
"language": "en_US",
"timezone": "Europe/Bucharest",
"landingPage": "dashboardV2"
},
"role": 5,
"rights": {
"companyManager": false,
"manageCompanies": false,
"manageNetworks": true,
"manageInventory ": true,
"managePoliciesRead": true,
"managePoliciesWrite": true,
"manageReports": true,
"manageUsers": true,
"manageRemoteShell":true
},
"companyName": "bitdefender",
"companyId": "58541613aaed7090058b4567"
},
{
"id": "585d3170aaed70b7048b4633",
"email": "[email protected]",
"profile": {
"fullName": "Bitdefender User",
"language": "en_US",
"timezone": "Europe/Bucharest"
},
"role": 1,
"rights": {
"companyManager": true,
"manageCompanies": false,
"manageNetworks": true,
"manageInventory ": true,
"managePoliciesRead": true,
"managePoliciesWrite": true,
"manageReports": true,
"manageUsers": true,
"manageRemoteShell":true
},
"passwordLifetime": 0,
"accountLockdown": false,
"twoFactorAuthenticationStatus": true,
"companyName": "bitdefender",
"companyId": "58541613aaed7090058b4567"
}
]
}
}