Skip to main content

DIT biometry service API 1.5.0

DIT biometry service integration methods.

Base path: https://{controller_ip}/api/v1. API description version: 1.5.0.

Examples use placeholder values for passwords, tokens, UUIDs, addresses and secrets. Replace them with values from your controller before sending requests.

In the source document, this block belongs to the DIT biometry service. clientSecret, password and other secrets in examples are replaced with placeholder values.

Section methods​

MethodPath
GET/biometry_services/dit
GET/biometry_services/dit/access_point
POST/biometry_services/dit
POST/biometry_services/dit/access_point
PUT/biometry_services/dit/access_point/{id}
PUT/biometry_services/dit/{id}
PATCH/biometry_services/dit/{id}
DELETE/biometry_services/dit/access_point/{id}
DELETE/biometry_services/dit/{id}

GET /biometry_services/dit​

Section: DIT biometry service.

Returns data for the dIT biometry service endpoint /biometry_services/dit.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/biometry_services/dit" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/biometry_services/dit" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/biometry_services/dit"
  }
}

GET /biometry_services/dit/access_point​

Section: DIT biometry service.

Returns data for the dIT biometry service endpoint /biometry_services/dit/access_point.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/biometry_services/dit/access_point" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/biometry_services/dit/access_point" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/biometry_services/dit/access_point"
  }
}

POST /biometry_services/dit​

Section: DIT biometry service.

Creates a record or starts an operation for the dIT biometry service endpoint /biometry_services/dit.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/biometry_services/dit" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "dit-service",
  "authHost": "<host>",
  "authPort": 30415,
  "apiHost": "<host>",
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "<client_id>",
  "clientSecret": "<client_secret>",
  "username": "<username>",
  "password": "<password>",
  "kafkaBroker": "<host:port>",
  "active": true
}'

Request body example​

{
  "name": "dit-service",
  "authHost": "<host>",
  "authPort": 30415,
  "apiHost": "<host>",
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "<client_id>",
  "clientSecret": "<client_secret>",
  "username": "<username>",
  "password": "<password>",
  "kafkaBroker": "<host:port>",
  "active": true
}

Response command example​

curl -k -sS -X POST "https://{controller_ip}/api/v1/biometry_services/dit" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

POST /biometry_services/dit/access_point​

Section: DIT biometry service.

Creates a record or starts an operation for the dIT biometry service endpoint /biometry_services/dit/access_point.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/biometry_services/dit/access_point" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "access_point_uuid": "<access_point_uuid>",
  "dit_service_id": "<dit_service_id>",
  "enabled": true
}'

Request body example​

{
  "access_point_uuid": "<access_point_uuid>",
  "dit_service_id": "<dit_service_id>",
  "enabled": true
}

Response command example​

curl -k -sS -X POST "https://{controller_ip}/api/v1/biometry_services/dit/access_point" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /biometry_services/dit/access_point/{id}​

Section: DIT biometry service.

Updates data for the dIT biometry service endpoint /biometry_services/dit/access_point/{id}.

Request example​

curl -k -X PUT "https://{controller_ip}/api/v1/biometry_services/dit/access_point/{id}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "access_point_uuid": "<access_point_uuid>",
  "dit_service_id": "<dit_service_id>",
  "enabled": true
}'

Request body example​

{
  "access_point_uuid": "<access_point_uuid>",
  "dit_service_id": "<dit_service_id>",
  "enabled": true
}

Response command example​

curl -k -sS -X PUT "https://{controller_ip}/api/v1/biometry_services/dit/access_point/{id}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /biometry_services/dit/{id}​

Section: DIT biometry service.

Updates data for the dIT biometry service endpoint /biometry_services/dit/{id}.

Request example​

curl -k -X PUT "https://{controller_ip}/api/v1/biometry_services/dit/{id}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "dit-service",
  "authHost": "<host>",
  "authPort": 30415,
  "apiHost": "<host>",
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "<client_id>",
  "clientSecret": "<client_secret>",
  "username": "<username>",
  "password": "<password>",
  "kafkaBroker": "<host:port>",
  "active": true
}'

Request body example​

{
  "name": "dit-service",
  "authHost": "<host>",
  "authPort": 30415,
  "apiHost": "<host>",
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "<client_id>",
  "clientSecret": "<client_secret>",
  "username": "<username>",
  "password": "<password>",
  "kafkaBroker": "<host:port>",
  "active": true
}

Response command example​

curl -k -sS -X PUT "https://{controller_ip}/api/v1/biometry_services/dit/{id}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PATCH /biometry_services/dit/{id}​

Section: DIT biometry service.

Updates data for the dIT biometry service endpoint /biometry_services/dit/{id}.

Request example​

curl -k -X PATCH "https://{controller_ip}/api/v1/biometry_services/dit/{id}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "dit-service",
  "authHost": "<host>",
  "authPort": 30415,
  "apiHost": "<host>",
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "<client_id>",
  "clientSecret": "<client_secret>",
  "username": "<username>",
  "password": "<password>",
  "kafkaBroker": "<host:port>",
  "active": true
}'

Request body example​

{
  "name": "dit-service",
  "authHost": "<host>",
  "authPort": 30415,
  "apiHost": "<host>",
  "apiPort": 30417,
  "basePath": "/v1",
  "authBasePath": "/v1",
  "clientId": "<client_id>",
  "clientSecret": "<client_secret>",
  "username": "<username>",
  "password": "<password>",
  "kafkaBroker": "<host:port>",
  "active": true
}

Response command example​

curl -k -sS -X PATCH "https://{controller_ip}/api/v1/biometry_services/dit/{id}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "active": true
}

DELETE /biometry_services/dit/access_point/{id}​

Section: DIT biometry service.

Deletes data for the dIT biometry service endpoint /biometry_services/dit/access_point/{id}.

Request example​

curl -k -X DELETE "https://{controller_ip}/api/v1/biometry_services/dit/access_point/{id}" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X DELETE "https://{controller_ip}/api/v1/biometry_services/dit/access_point/{id}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "deleted": true
}

DELETE /biometry_services/dit/{id}​

Section: DIT biometry service.

Deletes data for the dIT biometry service endpoint /biometry_services/dit/{id}.

Request example​

curl -k -X DELETE "https://{controller_ip}/api/v1/biometry_services/dit/{id}" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X DELETE "https://{controller_ip}/api/v1/biometry_services/dit/{id}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "deleted": true
}