Varade API

Siin saab hallata organisatsiooni infovarasid, nende klassifikatsiooni ja seoseid äriprotsesside, riskide ja meetmetega.

POST /assets/

Uue vara loomine.

Väli	Tüüp	Kohustuslik	Kirjeldus
title	string	Jah	Kordonis kuvatav nimi.
description	string	Jah	HTML-vormingus kirjeldus.
manager_id	UUID	Jah	Vara halduri kasutaja ID.
owner_id	UUID	Jah	Vara omaniku kasutaja ID.
asset_value	string	Jah	Väärtus: low (madal), medium (keskmine) või high (kõrge).
state	string	Ei	Elutsükli staatus: live (kasutuses), planned (planeeritud) või deprecated (mahakantud). Vaikimisi live.
label_ids	array	Ei	Massiiv siltide UUID-dest, mida varale lisada.

curl --location 'https://SINU_KORDONI_DOMEEN/api/v1/assets/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer SINU_VÕTI' \
--data '{
    "asset": {
        "title": "New asset name",
        "manager_id": "98dcb717-al70-4c89-8246-0bb026wc215b",
        "owner_id": "98dcb717-al70-4c89-8246-0bb026wc215b",
        "asset_value": "medium",
        "state": "live",
        "description": "<p>This was created through the API</p>",
        "label_ids": ["81bb6227-005f-4b1e-bf11-fbb9b96adb4d"]
    }
}'

Vastuse näide:

Loomispäringu vastus sisaldab loodud objekti täielikke andmeid.

Staatus 200

{
    "data": {
        "id": "4c38aec4-989f-4f1d-85ce-fcad34820716",
        "asset_value": "medium",
        "controls": [],
        "created_at": "2024-08-28T14:27:26+00:00",
        "description": "<p>This was created through the API</p>",
        "has_empty_controls": true,
        "has_failing_controls": false,
        "has_not_mitigated_risks": false,
        "labels": [],
        "manager": {
            "id": "98dcb717-al70-4c89-8246-0bb026wc215b",
            "name": "Jaana Manana"
        },
        "most_problematic_connection": {},
        "owner": {
            "id": "98dcb717-al70-4c89-8246-0bb026wc215b",
            "name": "Jaana Manana"
        },
        "risks": [],
        "state": "live",
        "sum_of_risk_scores": 0,
        "tasks": [],
        "title": "New asset name",
        "updated_at": "2024-08-28T14:27:26+00:00"
    }
}

GET /assets/:id

Vara pärimine ID järgi.

curl --location --request GET 'https://SINU_KORDONI_DOMEEN/api/v1/assets/580ee34d-4634-43b5-b082-952fdf4bd9b3' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer SINU_VÕTI'

Vastuse näide

Staatus: 200

{
    "data": {
        "id": "580ee34d-4634-43b5-b082-952fdf4bd9b3",
        "asset_value": "medium",
        "business_processes": [],
        "controls": [],
        "created_at": "2025-02-06T13:49:49+00:00",
        "description": "<p>Siin on kirjas midagi</p>",
        "labels": [],
        "manager": {
            "id": "eb58a210-3532-4412-98cb-5d14e56f0f62",
            "name": "Pierre Zapp"
        },
        "owner": {
            "id": "eb58a210-3532-4412-98cb-5d14e56f0f62",
            "name": "Pierre Zapp"
        },
        "risks": [],
        "state": "live",
        "sum_of_risk_scores": 0,
        "tasks": [],
        "title": "GCP",
        "updated_at": "2025-02-06T13:49:49+00:00",
        "vendors": [],
        "classification": null,
        "vendor_contact_email": null
    }
}

---

GET /assets/

Kõikide varade nimekiri

Päringu parameetrid

Parameeter	Tüüp	Kirjeldus
state[]	massiiv	Filtreeri staatuse järgi: live, planned, deprecated.
asset_value[]	massiiv	Filtreeri väärtuse järgi: low, medium, high.
health[]	massiiv	Filtreeri tervise järgi: with_failing_controls, with_no_controls, with_unmitigated_risks.
owner[]	massiiv	Filtreeri omaniku kasutaja ID-de järgi.
manager[]	massiiv	Filtreeri halduri kasutaja ID-de järgi.
labels[]	massiiv	Filtreeri sildi ID-de järgi. Kasuta väärtust none siltideta varade leidmiseks.

Massiivi parameetrid

Mitme väärtuse järgi filtreerimiseks korda parameetrit koos [] sulgudega iga väärtuse jaoks. Näiteks, et filtreerida varasid mis on live või planned:

?state[]=live&state[]=planned

See sulud märgistus kehtib kõikide massiivi parameetrite kohta (state[], asset_value[], health[] jne).

curl --location --request GET 'https://SINU_KORDONI_DOMEEN/api/v1/assets/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer SINU_VÕTI'

Näide filtritega:

curl --location --request GET 'https://SINU_KORDONI_DOMEEN/api/v1/assets/?state[]=live&state[]=planned&asset_value[]=high&health[]=with_failing_controls' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer SINU_VÕTI'

Vastuse näide

Staatus: 200

{
    "data": [
        {
            "id": "580ee34d-4634-43b5-b082-952fdf4bd9b3",
            "asset_value": "medium",
            "business_processes": [],
            "controls": [],
            "created_at": "2025-02-06T13:49:49+00:00",
            "description": "<p>Siin on kirjas midagi</p>",
            "labels": [],
            "manager": {
                "id": "eb58a210-3532-4412-98cb-5d14e56f0f62",
                "name": "Pierre Zapp"
            },
            "owner": {
                "id": "eb58a210-3532-4412-98cb-5d14e56f0f62",
                "name": "Pierre Zapp"
            },
            "permissions": {
                "update": true,
                "destroy": true,
                "connect": true
            },
            "risks": [],
            "state": "live",
            "sum_of_risk_scores": 0,
            "tasks": [],
            "title": "GCP",
            "updated_at": "2025-02-06T13:49:49+00:00",
            "vendors": [],
            "classification": null,
            "vendor_contact_email": null
        }
    ],
    "meta": {
        "total_count": 14,
        "page": 1,
        "permissions": {
            "create": true
        },
        "per_page": "1"
    }
}

PATCH /assets/:id

Uuenda olemasolevat vara. Kaasa ainult väljad, mida soovid muuta.

Uuendatavad väljad

Väli	Tüüp	Kirjeldus
title	string	Kordonis kuvatav nimi.
description	string	HTML-vormingus kirjeldus.
manager_id	UUID	Vara halduri kasutaja ID.
owner_id	UUID	Vara omaniku kasutaja ID.
asset_value	string	Väärtus: low, medium või high.
state	string	Elutsükli staatus: live, planned või deprecated.
label_ids	array	Massiiv siltide UUID-dest, mida varale lisada.

Saad ka uuendada kohandatud välju, lisades need päringu kehasse.

curl --location --request PATCH 'https://SINU_KORDONI_DOMEEN/api/v1/assets/a16083dc-2938-4c97-b77b-4669b53eae9a' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer SINU_VÕTI' \
--data '{
    "asset": {
        "title": "Uuendatud vara nimi",
        "asset_value": "high",
        "state": "planned",
        "label_ids": ["81bb6227-005f-4b1e-bf11-fbb9b96adb4d"]
    }
}'

Näide kohandatud väljaga:

Selles näites on internal_department_id vara objekti kohandatud väli.

curl --location --request PATCH 'https://SINU_KORDONI_DOMEEN/api/v1/assets/a16083dc-2938-4c97-b77b-4669b53eae9a' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer SINU_VÕTI' \
--data '{
    "asset": {
        "internal_department_id": "12"
    }
}'

Vastus sisaldab uuendatud objekti täielikke andmeid.

Staatus: 200

{
  "data": {
    "id": "0cbd4eb0-ac1d-4ec8-a426-e353bb65991a",
    "asset_value": "medium",
    "controls": [],
    "created_at": "2024-08-28T14:26:29+00:00",
    "description": "<p>tere tere</p>",
    "has_empty_controls": true,
    "has_failing_controls": false,
    "has_not_mitigated_risks": false,
    "labels": [],
    "manager": {
      "id": "98dcb717-al70-4c89-8246-0bb026wc215b",
      "name": "Jaana Manana",
      "user_type": "user"
    },
    "most_problematic_connection": {},
    "owner": {
      "id": "98dcb717-al70-4c89-8246-0bb026wc215b",
      "name": "Jaana Manana",
      "user_type": "user"
    },
    "risks": [],
    "state": "live",
    "sum_of_risk_scores": 0,
    "tasks": [],
    "title": "The laptops",
    "updated_at": "2024-08-30T05:20:19+00:00",
    "internal_department_id": "12"
  },
  "meta": {
    "custom_fields": [
      {
        "name": "internal_department_id",
        "label": "Internal department ID",
        "kind": "string"
      }
    ]
  }
}

DELETE /assets/:id

Kustuta vara.

curl --location --request DELETE 'https://SINU_KORDONI_DOMEEN/api/v1/assets/e856da13-f02e-4e3d-addc-ab96f4395a7b' \
--header 'Authorization: Bearer SINU_VÕTI' \
--data ''

Kustutamispäringu vastus sisaldab kustutatud objekti ID-d.

Vastuse näide:

Staatus 200

{
    "data": {
        "id": "e856da13-f02e-4e3d-addc-ab96f4395a7b"
    }
}

Vara sidemete haldamine

Varasid saab ühendada meetmete, riskide, tarnijate, äriprotsesside ja leidudega.

PATCH /assets/:id/connections

Uuenda vara sidemeid.

Sidemete parameetrid

Parameeter	Tüüp	Kirjeldus
control_ids	massiiv	Ühendatavate meetmete ID-d
risk_ids	massiiv	Ühendatavate riskide ID-d
vendor_ids	massiiv	Ühendatavate tarnijate ID-d
business_process_ids	massiiv	Ühendatavate äriprotsesside ID-d
finding_ids	massiiv	Ühendatavate leidude ID-d

Osalised uuendused

Ainult päringus kaasatud sidetüübid uuendatakse. Välja jäetud sidetüübid jäävad muutmata.

Sidemete asendamine

Sidetüübi uuendamisel pead kaasama kõik ID-d, mida soovid ühendatuna, mitte ainult uued.

• Sideme lisamiseks: kaasa kõik olemasolevad ID-d pluss uus ID
• Sideme eemaldamiseks: kaasa kõik ID-d välja arvatud eemaldatav
• Kõikide sidemete eemaldamiseks: kaasa tühi massiiv []

Vigased ID-d jäetakse vahele.

Näide: Uuenda vara sidemeid

curl --location PATCH \
--url "https://SINU_KORDONI_DOMEEN/api/v1/assets/580ee34d-4634-43b5-b082-952fdf4bd9b3/connections" \
--header "Authorization: Bearer SINU_VÕTI" \
--header "Content-Type: application/json" \
--data '{
    "connections": {
        "control_ids": [
            "18211d00-904f-4ca9-a212-1e616a687d83"
        ],
        "risk_ids": [
            "3efe0045-3562-4aa5-96bd-b17f13c4de79",
            "6d59f166-a777-40a2-8c1e-bbf79bb0fda4"
        ],
        "vendor_ids": [
            "b00f71e5-9cb4-4995-96e6-0e5710f85e0a"
        ],
        "business_process_ids": [
            "5a35e67e-f6b7-488d-86a2-6d7943ea6119"
        ]
    }
}'

Vastuse näide

Staatus: 200

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