Indexed Identity Resource

Definition

This is an object representing an indexed identity.

ENDPOINTS

GET /v1/index-collection/{COLLECTION_NAME}/identities/

GET /v1/index-collection/{COLLECTION_NAME}/identities/INDEX_ID/

PUT /v1/index-collection/{COLLECTION_NAME}/identities/

DELETE /v1/index-collection/{COLLECTION_NAME}/identities/INDEX_ID/

Attributes

Top level attributes

Name	Type	Description
index_id	string	ID of the Indexed Identity
label	string	Label of the Indexed Identity
collection_name	string	The name of the Index Collection object that the Indexed Identity is stored
thumbnail	Thumbnail object	Thumbnail of the Indexed Identity
time_created	string	Creation time of the Indexed Identity (ISO Time String)
time_updated	string	Modification time of the Indexed Identity (ISO Time String)

JSON Example

The following JSON snippet is showing an Index Collection object.

{
    "index_id": "3911163502",
    "label": "Max Mustermann",
    "collection_name": "default_index",
    "thumbnail": {
        "image": "iVBORw0KGgoAAAANSUhEUg...",
        "meta": {}
    },
    "time_created": "2020-01-01 00:00:00.786000",
    "time_updated": "2020-01-01 00:00:00.786000"
}