Skip to main content

getAccoutDetails

Use this method to retrieve information for a specific GravityZone account.

Parameters

Parameter

Description

Included in request

Type

Values

accountId

The ID of the account you want to display information for.

Optional

String

Default value: The ID of the GravityZone account used to generate the API key.

Return value

Attribute

Type

Description

email

String

The email address of the account.

profile

Object

This object contains the account's profile information:

  • fullName - The first and last name of the user associated to the account.

  • language - The language displayed in the GravityZone console.

  • timezone - The timezone the user.

  • landingPage - The page first displayed when the user logs into GravityZone.

phoneNumber

Object

This object contains the phone number information for the account:

  • countryCode - The prefix of the country where the phone number is located.

  • subscriberNumber - The phone number without the prefix.

role

Integer

The role of the new account.

Possible values:

  • 1 - Company Administrator

  • 2 - Network Administrator

  • 3 - Reporter

  • 5 - Custom.

For more information regarding user roles and the associated rights, refer to User roles

rights

Object

This object contains the rights associated to the user account:

  • manageCompanies - Allows users to create, delete, suspend, manage licensing and security for client companies.

  • manageNetworks - Provides administrative privileges over these network security settings:

    • Network inventory

    • Policies

    • Tasks

    • Installation packages

    • Quarantine

  • manageUsers - Allows users to create, delete, or edit user accounts for their own company.

  • manageReports - Allows users to create, view, and edit reports for their own company.

  • companyManager - Provides users access to edit their company profile settings and make changes to licensing.

  • manageRemoteShell - Enables users to start Remote Shell sessions on managed target endpoints and perform advanced forensics.

  • manageInventory - Provides administrative privileges over network inventories, tasks, installation packages and quarantined items.

  • managePoliciesRead - Allows users to view company policies.

  • managePoliciesWrite - Allows users to create and edit company policies.

  • manageMspTrialFeatures - Allows users to access and utilize the MSP Trial Hub feature.

passwordLifetime

Integer

Indicates the password expiration policy assigned to the user account.

Possible values:

  • 0 - the password will never expire.

  • 90 - the password will expire every 90 days.

    Tip

    When a password expires the owner will no longer be able to use it to log into GravityZone and will be prompted to create a new one.

accountLockdown

Boolean

Indicates if the user account is set to lock down after after 5 unsuccessful attempts.

twoFactorAuthenticationStatus

Boolean

Indicates if Two Factor Authentication (2FA) is activated for the user account.

companyName

String

The name of the company the user account belongs to.

companyId

String

The ID of the company the user account belongs to.

hasOwnCompanyInTargets

Boolean

Indicates if the user has access to manage the company it belongs to. This setting is the equivalent of the Select Tragets section available when creating or editing user accounts in GravityZone and indicates that user has access to top most level target.

Example

Request:

 {
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "jsonrpc": "2.0",    
    "method": "getAccountDetails",
    "params": {
      "accountId": "6718732309e2be32df0550c2"
    }
   }

Response:

{
  "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
  "jsonrpc": "2.0",
  "result": {
    "id": "6718732309e2be32df0550c2",
    "email": "[email protected]",
    "profile": {
      "fullName": "customer2",
      "language": "en_US",
      "timezone": "UTC",
      "landingPage": "dashboard"
    },
    "phoneNumber": {
      "countryCode": null,
      "subscriberNumber": null
    },
    "role": 1,
    "rights": {
      "manageCompanies": false,
      "manageInventory": true,
      "managePoliciesRead": true,
      "managePoliciesWrite": true,
      "manageUsers": true,
      "manageReports": true,
      "companyManager": true,
      "manageRemoteShell": true,
      "manageMspTrialFeatures": false
    },
    "passwordLifetime": 90,
    "accountLockdown": true,
    "twoFactorAuthenticationStatus": false,
    "companyName": "Customer_0_0",
    "companyId": "670fa2a2e0d7e2ea2907fec2",
    "hasOwnCompanyInTargets": true
  }
}
In this section: