# Entity Objects

#### **Entity Object**

The `entities` array contains one or more entity objects. Entity objects have the following special properties in addition to a large number of boolean flags.

| Property | Description                                                                                                                                                                                                                                                          |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| type     | The `type` property contains a single `type` specifier. For `IPv4` and `IPv6` entities the type will be set to `IPv4` or `IPv6` respectively. For any hash types the `type` will be set to `hash`. Finally, for any custom types the `type` will be set to `custom`. |
| types    | The `types` property is an array of type values. It will contain one or more matching types.                                                                                                                                                                         |
| value    | The value of the entity as seen on the user's screen                                                                                                                                                                                                                 |
| channels | An array of channel objects consiting of the channel id and channel name                                                                                                                                                                                             |

**value** (string)

The `value` property contains the value of the entity in string form

#### **type**

The `type` property contains a single `type` specifier. For `IPv4` and `IPv6` entities the type will be set to `IPv4` or `IPv6` respectively. For any hash types the `type` will be set to `hash`. Finally, for any custom types the `type` will be set to `custom`.

```javascript
// Sample IPv4 entity
{
    type: 'IPv4',
    types: ['IP', 'IPv4']
}

// Sample IPv6 entity
{
    type: 'IPv6',
    types: ['IP', 'IPv6']
}

// Sample MD5 entity
{
    type: 'hash',
    types: ['hash', 'MD5']
}

// Sample SHA1 entity
{
    type: 'hash',
    types: ['hash', 'SHA1']
}

// Sample custom entity 
{
    type: 'custom',
    types: ['custom.hostname']
}
```

**types**

The `types` property is an array of type values. It will contain one or more matching types.

For custom types the type value is taken from the `key` property specified in your configuration file prepended with the string `custom.`. For example, if you config file defined a custom type called hostname then you would look for the `types` property to contain the string `custom.hostname`.

As an example

Integration Config File

```javascript
{
    customTypes: [
        {
            key: 'hostname',
            regex: /[a-z]+_host/
        }
    ]
}
```

Then entity objects that contained that value would have the following format.

Matching Entity Object

```javascript
{
    type: 'custom',
    types: ['custom.hostname'],
    value: 'abba_host'
    // additional boolean flags would be false        
}
```

**channels**

The `channels` property is an array of zero of more channel objects that indicate what channels the given entity exists in (i.e., what channels that entity is tagged in). If an entity is not tagged, then the `channels` property will be an empty array.

Channel objects contain the following two properties:

***id***

Channel objects contain an `id` property which is the numeric `id` of the channel. Note that channel id values will not change unless the channel is deleted and recreated.

***name***

Channel objects also contain a `name` property which is the name of the channel. Note that channel names can change if a user edits the name of the channel.

{% code title="config/config.js" %}

```javascript
{
    channels: [
        {
            id: 13,
            name: 'web-servers'
        }
    ]
}
```

{% endcode %}

###


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.polarity.io/integrations/build-an-integration/main/dolookup/entity-objects.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.