getCompanyDetails
This method retrieves the details of a company.
Parameters
Parameter | Type | Optional | Description |
---|---|---|---|
companyId | String | Yes | The company's ID. The default value is the ID of the company linked to the user who generated the API key. |
Return value
This method returns an Object containing the details of the selected company:
type
- the company type: 0 for Partner, 1 for Customername
- the name of the companyid
- the ID of the companyaddress
- the address of the companyphone
- the phone of the companycanBeManagedByAbove
- the security management status for the company:true
, if the security can be managed by parent companiesenforce2FA
- a boolean specifying if the Two Factor Authentication (2FA) is enforced for user accounts belonging to the selected companyskip2FAPeriod
- an integer specifying the duration, in days, that the users can be exempted from providing a two-factor authentication code at loginisSuspended
- company account status:true
, if the company is suspendedcreatedAt
- a String representing the UTC date and time at which the company was createdcountry
- a String representing the country code in ISO 3166 format. If the code is not specified, the String has the valueN/A
state
- a String representing the country state code in ISO 3166 format. If the code is not specified, the String has the valueN/A
contactPerson
- an Object containing the details of the contact person:fullName
, their first name and surnameemail
, their business email addressphoneNumber
, their business phone numbercompanyRole
, their position in the company
riskScore
- an Object containing the following information about the company's security risks:value
, the company's security risk score value in percentage. It is broken down into misconfigurations, app vulnerabilities, human risks, and adjusted by the health industry modifierimpact
, the company's security risk impact (Low, Medium, High)misconfigurations
, the percentage of misconfigurations in the company's security risk scoreappVulnerabilities
, the percentage of app vulnerabilities in the company's security risk scorehumanRisks
, the percentage of human risks in the company's security risk scoreindustryModifier
, dynamically adjusts your company score based on CVEs discovered in your environment that have already been exploited at industry level
customFields
- an Object containing the custom fields values for the company:custom field name 1
, custom field value 1,custom field name 2
, custom field value 2
Example
Request:
{
"params": {
"companyId" : "5493dcd2b1a43df00b7b23c6"
},
"jsonrpc": "2.0",
"method": "getCompanyDetails",
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810"
}
Response:
{
"id":"0df7568c-59c1-48e0-a31b-18d83e6d9810",
"jsonrpc":"2.0",
"result": {
"type": 1,
"name": "Example LTD",
"id": "54aeab40b1a43dc0467b23e9",
"address": "Str Example No 1",
"phone": "0040740000001",
"canBeManagedByAbove": true,
"enforce2FA": true,
"skip2FAPeriod": 3
"isSuspended": false,
"createdAt": "2017-01-28T15:01:15",
"country": "CA",
"state": "CA-BC",
"contactPerson": {
"fullName": "Stephen Jhonson",
"email": "stephen.jhonsons@example.email.com",
"phoneNumber": "0040740000001",
"companyRole": "Owner / President"
},
"customFields": {
"referenceID":"004562",
"vertical":"healthcare",
"partner_type":"platinum",
"security_level":"high",
"payment_status":"goodstanding"
},
"riskScore": {
"value": "87%",
"impact": "High",
"misconfigurations": "70%",
"appVulnerabilities": "11%",
"humanRisks": "19%",
"industryModifier": "6%"
}
}
}