getAllCompanyIdentities

Use this method to retrieve all detected identities for a company.

Parameters

Name	Description	Included in request	Type	Values
`searchString`	A text value used to search and return only the identities whose names match the specified string.	Optional	String	No additional requirements. If not included, the response will include all identities. Example "searchString": "BDAdmin"

Name

Description

Included in request

Type

Values

searchString

A text value used to search and return only the identities whose names match the specified string.

Optional

String

No additional requirements.

If not included, the response will include all identities.

General parameters

These are common parameters, available across all public API methods.

Parameter	Description	Included in request	Type	Value requirements
`id`	This parameter adds an identifier to the request, linking it to its corresponding response. The target replies with the same value in the response, allowing easy call tracking.	Mandatory	String	No additional requirements. Example "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb"
`method`	The name of the method you are using to send the request.	Mandatory	String	Must be a valid method name. Example "method": "methodName"
`jsonrpc`	The version of JSON-RPC used by the request and the response.	Mandatory	Integer	The only possible value is `2.0`. `2.0` Example "jsonrpc": "2.0"
`params`	An object containing the configuration of the request.	Mandatory	Object	No additional requirements. Example "params": {...}
Under the `params` object
`page`	The results page number.	Optional	Integer	Default value: `1`.
`perPage`	The number of results displayed per page.	Optional	Integer	The upper limit is 100 items per page. Default value: `30`.

Return value

Attribute	Type	Description
`items`	Array of objects	Each object contains information on a identity.

Objects

`items`

Attribute	Type	Description
`behavioralProfileidentity`	String	The ID of the identity.
`behavioralProfileidentityName`	String	The name of the identity.

Example

Request:

    {
        "params": {
            "companyId": "67fe8595d4db0d536908ec92" - NOT required
            "page": 1, - NOT required
            "perPage": 10, - NOT required
            "$searchString": "DESKTOP" - NOT required
        },
        "jsonrpc": "2.0",
        "method": "getAllCompanyIdentities", - required
        "id": "b7e2c1d4-9f8a-4c2e-8b1a-ef1234567890"
    }

Response:

{
        "id": "b7e2c1d4-9f8a-4c2e-8b1a-ef1234567890",
        "jsonrpc": "2.0",
        "result": [
             {
                 "behavioralProfileIdentity": "Local_S-1-5-21-4003642952-1244496884-1545565483-1003_67ff9a5be8e045f5713ee6f6",
                 "behavioralProfileIdentityName": "DESKTOP-Q2C86HV\\BDAdmin",
                 "identityType": 0
             },
             {
                 "behavioralProfileIdentity": "AD_S-1-5-21-2018264366-2484004464-1617746825",
                 "behavioralProfileIdentityName": "DESKTOP-TEST4\\TEST_MULTi8",
                 "identityType": 1
             },
         ]
    }

In this section: