Leidude API

Siin saab hallata organisatsiooni turvaintsidente, mittevastavuste raporteid (NCR), auditi leide ja muid turvalisusega seotud avastusi.

Leiu tüübid

Saadaolevad leiu tüübid (kind):

incident - Turvaintsident
ncr - Mittevastavuse raport (NCR)
observation - Auditi vaatlus
opportunity - Parendusvõimalus

Leiu staatused

Saadaolevad leiu staatused:

open - Leid on aktiivne ja vajab tähelepanu
in_progress - Leiuga tegeletakse
resolved - Leid on lahendatud
closed - Leid on suletud ja arhiveeritud

Prioriteedi tasemed

Saadaolevad prioriteedi tasemed:

low - Madal prioriteet, minimaalne mõju
medium - Keskmine prioriteet, mõõdukas mõju
high - Kõrge prioriteet, oluline mõju

Seosed

Leiud võivad olla seotud järgmiste objektidega:

Varad - Infovarad, mida leid mõjutab
Meetmed - Turvameetmed, mis on leiuga seotud
Riskid - Riskid, mis on leiuga seotud
Nõuded - Vastavusnõuded, mis on leiuga seotud
Tarnijad - Kolmandad osapooled, kes on leiuga seotud
Ülesanded - Tegevused leiu lahendamiseks

GET `/findings/`

Kõikide leidude nimekiri koos filtreerimise võimalusega.

Päringu parameetrid

Parameeter	Tüüp	Kirjeldus
`kind[]`	massiiv	Filtreeri leiu tüübi järgi: `incident`, `ncr`, `observation`, `improvement`.
`state[]`	massiiv	Filtreeri staatuse järgi: `open`, `in_progress`, `resolved`, `closed`.
`priority[]`	massiiv	Filtreeri prioriteedi järgi: `low`, `medium`, `high`, `critical`.
`source[]`	massiiv	Filtreeri allika järgi (nt `Siseaudit`, `Välisaudit`).
`owner[]`	massiiv	Filtreeri omaniku kasutaja ID-de järgi.
`manager[]`	massiiv	Filtreeri halduri kasutaja ID-de järgi.

curl --location GET \
--url "https://SINU_KORDONI_DOMEEN/api/v1/findings/" \
--header "Authorization: Bearer SINU_VÕTI"

Näide filtritega:

curl --location GET \
--url "https://SINU_KORDONI_DOMEEN/api/v1/findings/?kind[]=incident&state[]=open&priority[]=high&priority[]=critical" \
--header "Authorization: Bearer SINU_VÕTI"

Vastuse näide

Staatus: 200

{
    "data": [
        {
            "id": "92a5f296-6910-4bbe-b366-9080f7d018f6",
            "assets": [],
            "controls": [],
            "created_at": "2025-11-12T09:20:10+00:00",
            "date_discovered": "2025-11-09T00:00:00+00:00",
            "description": "Security team identified a misconfigured S3 bucket with public access permissions. Immediate restriction required and data exposure analysis ongoing.",
            "kind": "incident",
            "labels": [],
            "manager": {
                "id": "0f27df97-00b0-44ea-b8f0-522ad901ac37",
                "active": true,
                "color": "#FA8C16",
                "kind": "person",
                "name": "Demo User"
            },
            "owner": {
                "id": "0f27df97-00b0-44ea-b8f0-522ad901ac37",
                "active": true,
                "color": "#FA8C16",
                "kind": "person",
                "name": "Demo User"
            },
            "priority": "high",
            "requirements": [],
            "risks": [],
            "source": null,
            "state": "open",
            "tasks": [],
            "title": "Misconfigured S3 Bucket Exposed Publicly",
            "updated_at": "2025-11-13T12:38:28+00:00",
            "vendors": []
        }
    ],
    "meta": {
        "total_count": 49,
        "page": 1,
        "permissions": {
            "create": true
        },
        "per_page": "10"
    }
}

GET `/findings/:id`

Konkreetse leiu otsimine ID järgi.

curl --location GET \
--url "https://SINU_KORDONI_DOMEEN/api/v1/findings/92a5f296-6910-4bbe-b366-9080f7d018f6" \
--header "Authorization: Bearer SINU_VÕTI"

Vastuse näide

Staatus: 200

{
    "data": {
        "id": "9ce45bc1-28de-4896-bc15-39443fc86d31",
        "assets": [
            {
                "id": "5a352625-2191-4083-92e5-e735b463a7a6",
                "state": "live",
                "title": "Customer Relationship Data"
            }
        ],
        "controls": [
            {
                "id": "9ac52938-6e5a-476e-9097-021b77cbe1fb",
                "state": "failing",
                "title": "Security Training"
            }
        ],
        "created_at": "2025-11-12T08:32:19+00:00",
        "date_discovered": "2025-11-12T00:00:00+00:00",
        "description": "Onboarding training hasn't been done for 2 new joiners.",
        "kind": "ncr",
        "labels": [],
        "manager": {
            "id": "58e7bf6e-618e-4c87-81fb-31b5ecee2d41",
            "active": true,
            "color": "#F5222D",
            "kind": "person",
            "name": "Danny Ocean"
        },
        "owner": {
            "id": "58e7bf6e-618e-4c87-81fb-31b5ecee2d41",
            "active": true,
            "color": "#F5222D",
            "kind": "person",
            "name": "Danny Ocean"
        },
        "priority": "medium",
        "requirements": [
            {
                "id": "690a7009-38ea-4935-a139-f1b495e46d56",
                "is_applicable": true,
                "regulations": [
                    {
                        "id": "fce9d4d7-ffae-4aa1-84ac-941288d75ba4",
                        "is_custom": false,
                        "title": "SOC 2"
                    }
                ],
                "title": "Attract, Develop, Retain Personnel in Line with Security Objectives"
            }
        ],
        "risks": [
            {
                "id": "6d59f166-a777-40a2-8c1e-bbf79bb0fda4",
                "state": "not_mitigated",
                "title": "Device theft"
            }
        ],
        "source": "Internal audit",
        "state": "open",
        "tasks": [],
        "title": "Onboarding training gap",
        "updated_at": "2025-11-12T08:33:35+00:00",
        "vendors": []
    }
}

POST `/findings/`

Loo uus leid.

Nõutavad parameetrid:

title - Leiu pealkiri
manager_id - Leiu halduri kasutaja ID
owner_id - Leiu omaniku kasutaja ID
kind - Leiu tüüp (vaata leiu tüüpe ülal)
state - Leiu staatus
priority - Leiu prioriteet (low, medium, high)
date_discovered - Leiu avastamise kuupäev (ISO 8601 formaat)
source - Leiu allikas (nt “Siseaudit”, “Välisaudit”)

Valikulised parameetrid:

description - Leiu detailne kirjeldus

curl --location POST \
--url "https://SINU_KORDONI_DOMEEN/api/v1/findings/" \
--header "Authorization: Bearer SINU_VÕTI" \
--header "Content-Type: application/json" \
--data '{
    "title": "Missing encryption on database",
    "description": "Production database identified without encryption at rest enabled.",
    "manager_id": "0f27df97-00b0-44ea-b8f0-522ad901ac37",
    "owner_id": "0f27df97-00b0-44ea-b8f0-522ad901ac37",
    "kind": "incident",
    "state": "open",
    "priority": "high",
    "date_discovered": "2025-11-20T00:00:00+00:00",
    "source": "Turvaaudit"
}'

PATCH `/findings/:id`

Uuenda olemasolevat leidu.

curl --location PATCH \
--url "https://SINU_KORDONI_DOMEEN/api/v1/findings/92a5f296-6910-4bbe-b366-9080f7d018f6" \
--header "Authorization: Bearer SINU_VÕTI" \
--header "Content-Type: application/json" \
--data '{
    "state": "resolved",
    "priority": "medium"
}'

Vastuse näide

Staatus: 200

Vastus sisaldab täielikku uuendatud leiu andmestikku.

DELETE `/findings/:id`

Kustuta leid.

curl --location DELETE \
--url "https://SINU_KORDONI_DOMEEN/api/v1/findings/92a5f296-6910-4bbe-b366-9080f7d018f6" \
--header "Authorization: Bearer SINU_VÕTI"

Vastuse näide

Staatus: 200

{
    "data": {
        "id": "92a5f296-6910-4bbe-b366-9080f7d018f6"
    }
}

Leiu sidemete haldamine

Leide saab ühendada nõuete, meetmete, riskide, varade ja tarnijatega.

PATCH `/findings/:id/connections`

Uuenda leiu sidemeid.

Sidemete parameetrid

Parameeter	Tüüp	Kirjeldus
`requirement_ids`	massiiv	Ühendatavate nõuete ID-d
`control_ids`	massiiv	Ühendatavate meetmete ID-d
`risk_ids`	massiiv	Ühendatavate riskide ID-d
`asset_ids`	massiiv	Ühendatavate varade ID-d
`vendor_ids`	massiiv	Ühendatavate tarnijate ID-d

Näide: Uuenda leiu sidemeid

curl --location PATCH \
--url "https://SINU_KORDONI_DOMEEN/api/v1/findings/92a5f296-6910-4bbe-b366-9080f7d018f6/connections" \
--header "Authorization: Bearer SINU_VÕTI" \
--header "Content-Type: application/json" \
--data '{
    "connections": {
        "requirement_ids": [
            "64fd3076-c1ff-4b05-9a96-aae96f3443dc"
        ],
        "control_ids": [
            "18211d00-904f-4ca9-a212-1e616a687d83"
        ],
        "risk_ids": [
            "3efe0045-3562-4aa5-96bd-b17f13c4de79"
        ],
        "asset_ids": [
            "0fb11fe0-85de-423d-ba63-b76598a9c743"
        ],
        "vendor_ids": [
            "b00f71e5-9cb4-4995-96e6-0e5710f85e0a"
        ]
    }
}'

Vastuse näide

Staatus: 200

Vastus sisaldab täielikku leiu objekti koos kõigi uuendatud sidetega.

Leidude API

Leiu tüübid

Leiu staatused

Prioriteedi tasemed

Seosed

GET /findings/

GET /findings/:id

POST /findings/

PATCH /findings/:id

DELETE /findings/:id

Leiu sidemete haldamine

PATCH /findings/:id/connections

GET `/findings/`

GET `/findings/:id`

POST `/findings/`

PATCH `/findings/:id`

DELETE `/findings/:id`

PATCH `/findings/:id/connections`