CISO Assistant API — Organization (0.7.0)

Download OpenAPI specification:

CISO Assistant - API Documentation for automating all your GRC needs

entities

entities_list

Override the list method to inject optimized data into the serializer context.

Authorizations:

knoxApiToken

query Parameters

contracts	Array of strings <uuid> [ items <uuid > ]
country	Array of strings Items Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "XK" "YE" "YT" "ZA" "ZM" "ZW" "x28" Country where the entity is located `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
currency	Array of strings Items Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BYR" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNH" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYI" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XCD" "XPF" "YER" "ZAR" "ZMK" "ZMW" "ZWL" "x46" Default currency for the entity `AED` - UAE Dirham `AFN` - Afghani `ALL` - Lek `AMD` - Armenian Dram `ANG` - Netherlands Antillean Guilder `AOA` - Kwanza `ARS` - Argentine Peso `AUD` - Australian Dollar `AWG` - Aruban Florin `AZN` - Azerbaijanian Manat `BAM` - Convertible Mark `BBD` - Barbados Dollar `BDT` - Taka `BGN` - Bulgarian Lev `BHD` - Bahraini Dinar `BIF` - Burundi Franc `BMD` - Bermudian Dollar `BND` - Brunei Dollar `BOB` - Boliviano `BOV` - Mvdol `BRL` - Brazilian Real `BSD` - Bahamian Dollar `BTN` - Ngultrum `BWP` - Pula `BYR` - Belarussian Ruble (2000 Series) `BYN` - Belarusian Ruble `BZD` - Belize Dollar `CAD` - Canadian Dollar `CDF` - Congolese Franc `CHE` - WIR Euro `CHF` - Swiss Franc `CHW` - WIR Franc `CLF` - Unidades de fomento `CLP` - Chilean Peso `CNY` - Yuan Renminbi `COP` - Colombian Peso `COU` - Unidad de Valor Real `CRC` - Costa Rican Colon `CUC` - Peso Convertible `CUP` - Cuban Peso `CVE` - Cape Verde Escudo `CZK` - Czech Koruna `DJF` - Djibouti Franc `DKK` - Danish Krone `DOP` - Dominican Peso `DZD` - Algerian Dinar `EGP` - Egyptian Pound `ERN` - Nakfa `ETB` - Ethiopian Birr `EUR` - Euro `FJD` - Fiji Dollar `FKP` - Falkland Islands Pound `GBP` - Pound Sterling `GEL` - Lari `GHS` - Ghana Cedi `GIP` - Gibraltar Pound `GMD` - Dalasi `GNF` - Guinea Franc `GTQ` - Quetzal `GYD` - Guyana Dollar `HKD` - Hong Kong Dollar `HNL` - Lempira `HTG` - Gourde `HUF` - Forint `IDR` - Rupiah `ILS` - New Israeli Sheqel `INR` - Indian Rupee `IQD` - Iraqi Dinar `IRR` - Iranian Rial `ISK` - Iceland Krona `JMD` - Jamaican Dollar `JOD` - Jordanian Dinar `JPY` - Yen `KES` - Kenyan Shilling `KGS` - Som `KHR` - Riel `KMF` - Comoro Franc `KPW` - North Korean Won `KRW` - Won `KWD` - Kuwaiti Dinar `KYD` - Cayman Islands Dollar `KZT` - Tenge `LAK` - Kip `LBP` - Lebanese Pound `LKR` - Sri Lanka Rupee `LRD` - Liberian Dollar `LSL` - Loti `LTL` - Lithuanian Litas `LVL` - Latvian Lats `LYD` - Libyan Dinar `MAD` - Moroccan Dirham `MDL` - Moldovan Leu `MGA` - Malagasy Ariary `MKD` - Denar `MMK` - Kyat `MNT` - Tugrik `MOP` - Pataca `MRO` - Ouguiya `MUR` - Mauritius Rupee `MVR` - Rufiyaa `MWK` - Kwacha `MXN` - Mexican Peso `MYR` - Malaysian Ringgit `MZN` - Mozambique Metical `NAD` - Namibia Dollar `NGN` - Naira `NIO` - Cordoba Oro `NOK` - Norwegian Krone `NPR` - Nepalese Rupee `NZD` - New Zealand Dollar `OMR` - Rial Omani `PAB` - Balboa `PEN` - Nuevo Sol `PGK` - Kina `PHP` - Philippine Peso `PKR` - Pakistan Rupee `PLN` - Zloty `PYG` - Guarani `QAR` - Qatari Rial `RON` - New Romanian Leu `RSD` - Serbian Dinar `RUB` - Russian Ruble `RWF` - Rwanda Franc `SAR` - Saudi Riyal `SBD` - Solomon Islands Dollar `SCR` - Seychelles Rupee `SDG` - Sudanese Pound `SEK` - Swedish Krona `SGD` - Singapore Dollar `SHP` - Saint Helena Pound `SLL` - Leone `SOS` - Somali Shilling `SRD` - Surinam Dollar `SSP` - South Sudanese Pound `STD` - Dobra `SVC` - El Salvador Colon `SYP` - Syrian Pound `SZL` - Lilangeni `THB` - Baht `TJS` - Somoni `TMT` - Turkmenistan New Manat `TND` - Tunisian Dinar `TOP` - Pa'anga `TRY` - Turkish Lira `TTD` - Trinidad and Tobago Dollar `TWD` - New Taiwan Dollar `TZS` - Tanzanian Shilling `UAH` - Hryvnia `UGX` - Uganda Shilling `USD` - US Dollar `UYI` - Uruguay Peso en Unidades Indexadas (URUIURUI) `UYU` - Peso Uruguayo `UZS` - Uzbekistan Sum `VEF` - Bolivar `VND` - Dong `VUV` - Vatu `WST` - Tala `XCD` - East Caribbean Dollar `YER` - Yemeni Rial `ZAR` - Rand `ZMK` - Zambian Kwacha (replaced January 1, 2013) `ZMW` - Zambian Kwacha `ZWL` - Zimbabwe Dollar `x46` - Other Currency (open axis tables) `XPF` - CFP Franc `CNH` - Off-shore Yuan Renminbi
default_dependency	integer
default_maturity	integer
default_penetration	integer
default_trust	integer
dora_competent_authority	string
dora_entity_hierarchy	Array of strings Items Enum: "eba_RP:x21" "eba_RP:x210" "eba_RP:x53" "eba_RP:x551" "eba_RP:x56" DORA entity hierarchy classification `eba_RP:x53` - Ultimate parent `eba_RP:x551` - Parent other than ultimate parent `eba_RP:x56` - Subsidiary `eba_RP:x21` - Entities other than entities of the group `eba_RP:x210` - Outsourcing
dora_entity_type	Array of strings Items Enum: "eba_CT:x12" "eba_CT:x300" "eba_CT:x301" "eba_CT:x302" "eba_CT:x303" "eba_CT:x304" "eba_CT:x305" "eba_CT:x306" "eba_CT:x307" "eba_CT:x308" "eba_CT:x309" "eba_CT:x310" "eba_CT:x311" "eba_CT:x312" "eba_CT:x313" "eba_CT:x314" "eba_CT:x315" "eba_CT:x316" "eba_CT:x317" "eba_CT:x318" "eba_CT:x320" "eba_CT:x599" "eba_CT:x639" "eba_CT:x643" DORA entity type classification `eba_CT:x12` - Credit institutions `eba_CT:x599` - Investment firms `eba_CT:x643` - Central counterparties (CCPs) `eba_CT:x639` - Asset management companies `eba_CT:x301` - Account information service providers `eba_CT:x302` - Electronic money institutions `eba_CT:x303` - Crypto-asset service providers `eba_CT:x304` - Central security depository `eba_CT:x305` - Trading venues `eba_CT:x306` - Trade repositories `eba_CT:x300` - Payment institution `eba_CT:x316` - Other financial entity `eba_CT:x315` - Securitisation repository `eba_CT:x314` - Crowdfunding service providers `eba_CT:x313` - Administrator of critical benchmarks `eba_CT:x312` - Credit rating agency `eba_CT:x311` - Institutions for occupational retirement provision `eba_CT:x320` - Insurance intermediaries, reinsurance intermediaries and ancillary insurance intermediaries `eba_CT:x309` - Insurance and reinsurance undertakings `eba_CT:x308` - Data reporting service providers `eba_CT:x307` - Managers of alternative investment funds `eba_CT:x318` - Non-financial entity: Other than ICT intra-group service provider `eba_CT:x317` - Non-financial entity: ICT intra-group service provider `eba_CT:x310` - Issuers of asset-referenced tokens
filtering_labels	Array of strings <uuid> [ items <uuid > ]
folder	Array of strings <uuid> [ items <uuid > ]
id	Array of strings <uuid> [ items <uuid > ] Multiple values may be separated by commas.
is_active	boolean
limit	integer Number of results to return per page.
name	string
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
parent_entity	Array of strings <uuid> [ items <uuid > ]
ref_id	string
relationship	Array of strings <uuid> [ items <uuid > ]
relationship__name	string
search	string A search term.

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"folder": "string",
"owned_folders": ["string"
],
"parent_entity": "string",
"branches": ["string"
],
"relationship": ["string"
],
"contracts": ["string"
],
"legal_identifiers": "string",
"default_criticality": "string",
"filtering_labels": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"default_dependency": 4,
"default_penetration": 4,
"default_maturity": 1,
"default_trust": 1,
"mission": "string",
"reference_link": "http://example.com",
"builtin": true,
"country": "AF",
"currency": "AED",
"dora_entity_type": "eba_CT:x12",
"dora_entity_hierarchy": "eba_RP:x53",
"dora_assets_value": 0.1,
"dora_competent_authority": "string",
"dora_provider_person_type": "eba_CT:x212"
}
]
}

entities_create

API endpoint that allows entities to be viewed or edited.

Authorizations:

knoxApiToken

Request Body schema:
application/json
required

is_published	boolean (Published)
name required	string <= 200 characters
description	string or null
ref_id	string <= 255 characters
is_active	boolean
default_dependency	integer [ 0 .. 4 ] Default dependency level for stakeholder assessment (0-4)
default_penetration	integer [ 0 .. 4 ] Default penetration level for stakeholder assessment (0-4)
default_maturity	integer [ 1 .. 4 ] Default maturity level for stakeholder assessment (1-4)
default_trust	integer [ 1 .. 4 ] Default trust level for stakeholder assessment (1-4)
mission	string
reference_link	string or null <uri> <= 2048 characters
builtin	boolean
legal_identifiers	any Legal identifiers (LEI, EUID, VAT, DUNS, etc.)
	CountryEnum (string) or BlankEnum (any) Country where the entity is located `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
	CurrencyEnum (string) or BlankEnum (any) Default currency for the entity `AED` - UAE Dirham `AFN` - Afghani `ALL` - Lek `AMD` - Armenian Dram `ANG` - Netherlands Antillean Guilder `AOA` - Kwanza `ARS` - Argentine Peso `AUD` - Australian Dollar `AWG` - Aruban Florin `AZN` - Azerbaijanian Manat `BAM` - Convertible Mark `BBD` - Barbados Dollar `BDT` - Taka `BGN` - Bulgarian Lev `BHD` - Bahraini Dinar `BIF` - Burundi Franc `BMD` - Bermudian Dollar `BND` - Brunei Dollar `BOB` - Boliviano `BOV` - Mvdol `BRL` - Brazilian Real `BSD` - Bahamian Dollar `BTN` - Ngultrum `BWP` - Pula `BYR` - Belarussian Ruble (2000 Series) `BYN` - Belarusian Ruble `BZD` - Belize Dollar `CAD` - Canadian Dollar `CDF` - Congolese Franc `CHE` - WIR Euro `CHF` - Swiss Franc `CHW` - WIR Franc `CLF` - Unidades de fomento `CLP` - Chilean Peso `CNY` - Yuan Renminbi `COP` - Colombian Peso `COU` - Unidad de Valor Real `CRC` - Costa Rican Colon `CUC` - Peso Convertible `CUP` - Cuban Peso `CVE` - Cape Verde Escudo `CZK` - Czech Koruna `DJF` - Djibouti Franc `DKK` - Danish Krone `DOP` - Dominican Peso `DZD` - Algerian Dinar `EGP` - Egyptian Pound `ERN` - Nakfa `ETB` - Ethiopian Birr `EUR` - Euro `FJD` - Fiji Dollar `FKP` - Falkland Islands Pound `GBP` - Pound Sterling `GEL` - Lari `GHS` - Ghana Cedi `GIP` - Gibraltar Pound `GMD` - Dalasi `GNF` - Guinea Franc `GTQ` - Quetzal `GYD` - Guyana Dollar `HKD` - Hong Kong Dollar `HNL` - Lempira `HTG` - Gourde `HUF` - Forint `IDR` - Rupiah `ILS` - New Israeli Sheqel `INR` - Indian Rupee `IQD` - Iraqi Dinar `IRR` - Iranian Rial `ISK` - Iceland Krona `JMD` - Jamaican Dollar `JOD` - Jordanian Dinar `JPY` - Yen `KES` - Kenyan Shilling `KGS` - Som `KHR` - Riel `KMF` - Comoro Franc `KPW` - North Korean Won `KRW` - Won `KWD` - Kuwaiti Dinar `KYD` - Cayman Islands Dollar `KZT` - Tenge `LAK` - Kip `LBP` - Lebanese Pound `LKR` - Sri Lanka Rupee `LRD` - Liberian Dollar `LSL` - Loti `LTL` - Lithuanian Litas `LVL` - Latvian Lats `LYD` - Libyan Dinar `MAD` - Moroccan Dirham `MDL` - Moldovan Leu `MGA` - Malagasy Ariary `MKD` - Denar `MMK` - Kyat `MNT` - Tugrik `MOP` - Pataca `MRO` - Ouguiya `MUR` - Mauritius Rupee `MVR` - Rufiyaa `MWK` - Kwacha `MXN` - Mexican Peso `MYR` - Malaysian Ringgit `MZN` - Mozambique Metical `NAD` - Namibia Dollar `NGN` - Naira `NIO` - Cordoba Oro `NOK` - Norwegian Krone `NPR` - Nepalese Rupee `NZD` - New Zealand Dollar `OMR` - Rial Omani `PAB` - Balboa `PEN` - Nuevo Sol `PGK` - Kina `PHP` - Philippine Peso `PKR` - Pakistan Rupee `PLN` - Zloty `PYG` - Guarani `QAR` - Qatari Rial `RON` - New Romanian Leu `RSD` - Serbian Dinar `RUB` - Russian Ruble `RWF` - Rwanda Franc `SAR` - Saudi Riyal `SBD` - Solomon Islands Dollar `SCR` - Seychelles Rupee `SDG` - Sudanese Pound `SEK` - Swedish Krona `SGD` - Singapore Dollar `SHP` - Saint Helena Pound `SLL` - Leone `SOS` - Somali Shilling `SRD` - Surinam Dollar `SSP` - South Sudanese Pound `STD` - Dobra `SVC` - El Salvador Colon `SYP` - Syrian Pound `SZL` - Lilangeni `THB` - Baht `TJS` - Somoni `TMT` - Turkmenistan New Manat `TND` - Tunisian Dinar `TOP` - Pa'anga `TRY` - Turkish Lira `TTD` - Trinidad and Tobago Dollar `TWD` - New Taiwan Dollar `TZS` - Tanzanian Shilling `UAH` - Hryvnia `UGX` - Uganda Shilling `USD` - US Dollar `UYI` - Uruguay Peso en Unidades Indexadas (URUIURUI) `UYU` - Peso Uruguayo `UZS` - Uzbekistan Sum `VEF` - Bolivar `VND` - Dong `VUV` - Vatu `WST` - Tala `XCD` - East Caribbean Dollar `YER` - Yemeni Rial `ZAR` - Rand `ZMK` - Zambian Kwacha (replaced January 1, 2013) `ZMW` - Zambian Kwacha `ZWL` - Zimbabwe Dollar `x46` - Other Currency (open axis tables) `XPF` - CFP Franc `CNH` - Off-shore Yuan Renminbi
	DoraEntityTypeEnum (string) or BlankEnum (any) DORA entity type classification `eba_CT:x12` - Credit institutions `eba_CT:x599` - Investment firms `eba_CT:x643` - Central counterparties (CCPs) `eba_CT:x639` - Asset management companies `eba_CT:x301` - Account information service providers `eba_CT:x302` - Electronic money institutions `eba_CT:x303` - Crypto-asset service providers `eba_CT:x304` - Central security depository `eba_CT:x305` - Trading venues `eba_CT:x306` - Trade repositories `eba_CT:x300` - Payment institution `eba_CT:x316` - Other financial entity `eba_CT:x315` - Securitisation repository `eba_CT:x314` - Crowdfunding service providers `eba_CT:x313` - Administrator of critical benchmarks `eba_CT:x312` - Credit rating agency `eba_CT:x311` - Institutions for occupational retirement provision `eba_CT:x320` - Insurance intermediaries, reinsurance intermediaries and ancillary insurance intermediaries `eba_CT:x309` - Insurance and reinsurance undertakings `eba_CT:x308` - Data reporting service providers `eba_CT:x307` - Managers of alternative investment funds `eba_CT:x318` - Non-financial entity: Other than ICT intra-group service provider `eba_CT:x317` - Non-financial entity: ICT intra-group service provider `eba_CT:x310` - Issuers of asset-referenced tokens
	DoraEntityHierarchyEnum (string) or BlankEnum (any) DORA entity hierarchy classification `eba_RP:x53` - Ultimate parent `eba_RP:x551` - Parent other than ultimate parent `eba_RP:x56` - Subsidiary `eba_RP:x21` - Entities other than entities of the group `eba_RP:x210` - Outsourcing
dora_assets_value	number or null <double> Total assets value for DORA reporting
dora_competent_authority	string <= 255 characters Competent authority overseeing this entity for DORA compliance
	DoraProviderPersonTypeEnum (string) or BlankEnum (any) Type of person for ICT third-party service providers `eba_CT:x212` - Legal person, excluding individual acting in a business capacity `eba_CT:x213` - Individual acting in a business capacity
folder	string <uuid>
parent_entity	string or null <uuid> Parent entity for branch/subsidiary relationships
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]
relationship	Array of strings <uuid> [ items <uuid > ] Type of relationship with this entity

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"default_dependency": 4,
"default_penetration": 4,
"default_maturity": 1,
"default_trust": 1,
"mission": "string",
"reference_link": "http://example.com",
"builtin": true,
"legal_identifiers": null,
"country": "AF",
"currency": "AED",
"dora_entity_type": "eba_CT:x12",
"dora_entity_hierarchy": "eba_RP:x53",
"dora_assets_value": 0.1,
"dora_competent_authority": "string",
"dora_provider_person_type": "eba_CT:x212",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"parent_entity": "92c9ade6-1fd3-4213-86a2-6043a67b6c18",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"relationship": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"default_dependency": 4,
"default_penetration": 4,
"default_maturity": 1,
"default_trust": 1,
"mission": "string",
"reference_link": "http://example.com",
"builtin": true,
"legal_identifiers": null,
"country": "AF",
"currency": "AED",
"dora_entity_type": "eba_CT:x12",
"dora_entity_hierarchy": "eba_RP:x53",
"dora_assets_value": 0.1,
"dora_competent_authority": "string",
"dora_provider_person_type": "eba_CT:x212",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"parent_entity": "92c9ade6-1fd3-4213-86a2-6043a67b6c18",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"relationship": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

entities_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Entity.

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"folder": "string",
"owned_folders": ["string"
],
"parent_entity": "string",
"branches": ["string"
],
"relationship": ["string"
],
"contracts": ["string"
],
"legal_identifiers": "string",
"default_criticality": "string",
"filtering_labels": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"default_dependency": 4,
"default_penetration": 4,
"default_maturity": 1,
"default_trust": 1,
"mission": "string",
"reference_link": "http://example.com",
"builtin": true,
"country": "AF",
"currency": "AED",
"dora_entity_type": "eba_CT:x12",
"dora_entity_hierarchy": "eba_RP:x53",
"dora_assets_value": 0.1,
"dora_competent_authority": "string",
"dora_provider_person_type": "eba_CT:x212"
}

entities_update

API endpoint that allows entities to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Entity.

Request Body schema:
application/json
required

is_published	boolean (Published)
name required	string <= 200 characters
description	string or null
ref_id	string <= 255 characters
is_active	boolean
default_dependency	integer [ 0 .. 4 ] Default dependency level for stakeholder assessment (0-4)
default_penetration	integer [ 0 .. 4 ] Default penetration level for stakeholder assessment (0-4)
default_maturity	integer [ 1 .. 4 ] Default maturity level for stakeholder assessment (1-4)
default_trust	integer [ 1 .. 4 ] Default trust level for stakeholder assessment (1-4)
mission	string
reference_link	string or null <uri> <= 2048 characters
builtin	boolean
legal_identifiers	any Legal identifiers (LEI, EUID, VAT, DUNS, etc.)
	CountryEnum (string) or BlankEnum (any) Country where the entity is located `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
	CurrencyEnum (string) or BlankEnum (any) Default currency for the entity `AED` - UAE Dirham `AFN` - Afghani `ALL` - Lek `AMD` - Armenian Dram `ANG` - Netherlands Antillean Guilder `AOA` - Kwanza `ARS` - Argentine Peso `AUD` - Australian Dollar `AWG` - Aruban Florin `AZN` - Azerbaijanian Manat `BAM` - Convertible Mark `BBD` - Barbados Dollar `BDT` - Taka `BGN` - Bulgarian Lev `BHD` - Bahraini Dinar `BIF` - Burundi Franc `BMD` - Bermudian Dollar `BND` - Brunei Dollar `BOB` - Boliviano `BOV` - Mvdol `BRL` - Brazilian Real `BSD` - Bahamian Dollar `BTN` - Ngultrum `BWP` - Pula `BYR` - Belarussian Ruble (2000 Series) `BYN` - Belarusian Ruble `BZD` - Belize Dollar `CAD` - Canadian Dollar `CDF` - Congolese Franc `CHE` - WIR Euro `CHF` - Swiss Franc `CHW` - WIR Franc `CLF` - Unidades de fomento `CLP` - Chilean Peso `CNY` - Yuan Renminbi `COP` - Colombian Peso `COU` - Unidad de Valor Real `CRC` - Costa Rican Colon `CUC` - Peso Convertible `CUP` - Cuban Peso `CVE` - Cape Verde Escudo `CZK` - Czech Koruna `DJF` - Djibouti Franc `DKK` - Danish Krone `DOP` - Dominican Peso `DZD` - Algerian Dinar `EGP` - Egyptian Pound `ERN` - Nakfa `ETB` - Ethiopian Birr `EUR` - Euro `FJD` - Fiji Dollar `FKP` - Falkland Islands Pound `GBP` - Pound Sterling `GEL` - Lari `GHS` - Ghana Cedi `GIP` - Gibraltar Pound `GMD` - Dalasi `GNF` - Guinea Franc `GTQ` - Quetzal `GYD` - Guyana Dollar `HKD` - Hong Kong Dollar `HNL` - Lempira `HTG` - Gourde `HUF` - Forint `IDR` - Rupiah `ILS` - New Israeli Sheqel `INR` - Indian Rupee `IQD` - Iraqi Dinar `IRR` - Iranian Rial `ISK` - Iceland Krona `JMD` - Jamaican Dollar `JOD` - Jordanian Dinar `JPY` - Yen `KES` - Kenyan Shilling `KGS` - Som `KHR` - Riel `KMF` - Comoro Franc `KPW` - North Korean Won `KRW` - Won `KWD` - Kuwaiti Dinar `KYD` - Cayman Islands Dollar `KZT` - Tenge `LAK` - Kip `LBP` - Lebanese Pound `LKR` - Sri Lanka Rupee `LRD` - Liberian Dollar `LSL` - Loti `LTL` - Lithuanian Litas `LVL` - Latvian Lats `LYD` - Libyan Dinar `MAD` - Moroccan Dirham `MDL` - Moldovan Leu `MGA` - Malagasy Ariary `MKD` - Denar `MMK` - Kyat `MNT` - Tugrik `MOP` - Pataca `MRO` - Ouguiya `MUR` - Mauritius Rupee `MVR` - Rufiyaa `MWK` - Kwacha `MXN` - Mexican Peso `MYR` - Malaysian Ringgit `MZN` - Mozambique Metical `NAD` - Namibia Dollar `NGN` - Naira `NIO` - Cordoba Oro `NOK` - Norwegian Krone `NPR` - Nepalese Rupee `NZD` - New Zealand Dollar `OMR` - Rial Omani `PAB` - Balboa `PEN` - Nuevo Sol `PGK` - Kina `PHP` - Philippine Peso `PKR` - Pakistan Rupee `PLN` - Zloty `PYG` - Guarani `QAR` - Qatari Rial `RON` - New Romanian Leu `RSD` - Serbian Dinar `RUB` - Russian Ruble `RWF` - Rwanda Franc `SAR` - Saudi Riyal `SBD` - Solomon Islands Dollar `SCR` - Seychelles Rupee `SDG` - Sudanese Pound `SEK` - Swedish Krona `SGD` - Singapore Dollar `SHP` - Saint Helena Pound `SLL` - Leone `SOS` - Somali Shilling `SRD` - Surinam Dollar `SSP` - South Sudanese Pound `STD` - Dobra `SVC` - El Salvador Colon `SYP` - Syrian Pound `SZL` - Lilangeni `THB` - Baht `TJS` - Somoni `TMT` - Turkmenistan New Manat `TND` - Tunisian Dinar `TOP` - Pa'anga `TRY` - Turkish Lira `TTD` - Trinidad and Tobago Dollar `TWD` - New Taiwan Dollar `TZS` - Tanzanian Shilling `UAH` - Hryvnia `UGX` - Uganda Shilling `USD` - US Dollar `UYI` - Uruguay Peso en Unidades Indexadas (URUIURUI) `UYU` - Peso Uruguayo `UZS` - Uzbekistan Sum `VEF` - Bolivar `VND` - Dong `VUV` - Vatu `WST` - Tala `XCD` - East Caribbean Dollar `YER` - Yemeni Rial `ZAR` - Rand `ZMK` - Zambian Kwacha (replaced January 1, 2013) `ZMW` - Zambian Kwacha `ZWL` - Zimbabwe Dollar `x46` - Other Currency (open axis tables) `XPF` - CFP Franc `CNH` - Off-shore Yuan Renminbi
	DoraEntityTypeEnum (string) or BlankEnum (any) DORA entity type classification `eba_CT:x12` - Credit institutions `eba_CT:x599` - Investment firms `eba_CT:x643` - Central counterparties (CCPs) `eba_CT:x639` - Asset management companies `eba_CT:x301` - Account information service providers `eba_CT:x302` - Electronic money institutions `eba_CT:x303` - Crypto-asset service providers `eba_CT:x304` - Central security depository `eba_CT:x305` - Trading venues `eba_CT:x306` - Trade repositories `eba_CT:x300` - Payment institution `eba_CT:x316` - Other financial entity `eba_CT:x315` - Securitisation repository `eba_CT:x314` - Crowdfunding service providers `eba_CT:x313` - Administrator of critical benchmarks `eba_CT:x312` - Credit rating agency `eba_CT:x311` - Institutions for occupational retirement provision `eba_CT:x320` - Insurance intermediaries, reinsurance intermediaries and ancillary insurance intermediaries `eba_CT:x309` - Insurance and reinsurance undertakings `eba_CT:x308` - Data reporting service providers `eba_CT:x307` - Managers of alternative investment funds `eba_CT:x318` - Non-financial entity: Other than ICT intra-group service provider `eba_CT:x317` - Non-financial entity: ICT intra-group service provider `eba_CT:x310` - Issuers of asset-referenced tokens
	DoraEntityHierarchyEnum (string) or BlankEnum (any) DORA entity hierarchy classification `eba_RP:x53` - Ultimate parent `eba_RP:x551` - Parent other than ultimate parent `eba_RP:x56` - Subsidiary `eba_RP:x21` - Entities other than entities of the group `eba_RP:x210` - Outsourcing
dora_assets_value	number or null <double> Total assets value for DORA reporting
dora_competent_authority	string <= 255 characters Competent authority overseeing this entity for DORA compliance
	DoraProviderPersonTypeEnum (string) or BlankEnum (any) Type of person for ICT third-party service providers `eba_CT:x212` - Legal person, excluding individual acting in a business capacity `eba_CT:x213` - Individual acting in a business capacity
folder	string <uuid>
parent_entity	string or null <uuid> Parent entity for branch/subsidiary relationships
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]
relationship	Array of strings <uuid> [ items <uuid > ] Type of relationship with this entity

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"default_dependency": 4,
"default_penetration": 4,
"default_maturity": 1,
"default_trust": 1,
"mission": "string",
"reference_link": "http://example.com",
"builtin": true,
"legal_identifiers": null,
"country": "AF",
"currency": "AED",
"dora_entity_type": "eba_CT:x12",
"dora_entity_hierarchy": "eba_RP:x53",
"dora_assets_value": 0.1,
"dora_competent_authority": "string",
"dora_provider_person_type": "eba_CT:x212",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"parent_entity": "92c9ade6-1fd3-4213-86a2-6043a67b6c18",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"relationship": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"default_dependency": 4,
"default_penetration": 4,
"default_maturity": 1,
"default_trust": 1,
"mission": "string",
"reference_link": "http://example.com",
"builtin": true,
"legal_identifiers": null,
"country": "AF",
"currency": "AED",
"dora_entity_type": "eba_CT:x12",
"dora_entity_hierarchy": "eba_RP:x53",
"dora_assets_value": 0.1,
"dora_competent_authority": "string",
"dora_provider_person_type": "eba_CT:x212",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"parent_entity": "92c9ade6-1fd3-4213-86a2-6043a67b6c18",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"relationship": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

entities_partial_update

API endpoint that allows entities to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Entity.

Request Body schema:
application/json

is_published	boolean (Published)
name	string <= 200 characters
description	string or null
ref_id	string <= 255 characters
is_active	boolean
default_dependency	integer [ 0 .. 4 ] Default dependency level for stakeholder assessment (0-4)
default_penetration	integer [ 0 .. 4 ] Default penetration level for stakeholder assessment (0-4)
default_maturity	integer [ 1 .. 4 ] Default maturity level for stakeholder assessment (1-4)
default_trust	integer [ 1 .. 4 ] Default trust level for stakeholder assessment (1-4)
mission	string
reference_link	string or null <uri> <= 2048 characters
builtin	boolean
legal_identifiers	any Legal identifiers (LEI, EUID, VAT, DUNS, etc.)
	CountryEnum (string) or BlankEnum (any) Country where the entity is located `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia, Plurinational State of `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei Darussalam `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `KH` - Cambodia `CM` - Cameroon `CA` - Canada `CV` - Cape Verde `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo, The Democratic Republic of the `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czech Republic `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See (Vatican City State) `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran, Islamic Republic of `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `KP` - Korea, Democratic People's Republic of `KR` - Korea, Republic of `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Lao People's Democratic Republic `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MK` - North Macedonia `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia, Federated States of `MD` - Moldova, Republic of `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestinian Territory, Occupied `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russian Federation `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SZ` - Swaziland `SE` - Sweden `CH` - Switzerland `SY` - Syrian Arab Republic `TW` - Taiwan, Province of China `TJ` - Tajikistan `TZ` - Tanzania, United Republic of `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `US` - United States `UM` - United States Minor Outlying Islands `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela, Bolivarian Republic of `VN` - Viet Nam `VG` - Virgin Islands, British `VI` - Virgin Islands, U.S. `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe `x28` - Other Countries
	CurrencyEnum (string) or BlankEnum (any) Default currency for the entity `AED` - UAE Dirham `AFN` - Afghani `ALL` - Lek `AMD` - Armenian Dram `ANG` - Netherlands Antillean Guilder `AOA` - Kwanza `ARS` - Argentine Peso `AUD` - Australian Dollar `AWG` - Aruban Florin `AZN` - Azerbaijanian Manat `BAM` - Convertible Mark `BBD` - Barbados Dollar `BDT` - Taka `BGN` - Bulgarian Lev `BHD` - Bahraini Dinar `BIF` - Burundi Franc `BMD` - Bermudian Dollar `BND` - Brunei Dollar `BOB` - Boliviano `BOV` - Mvdol `BRL` - Brazilian Real `BSD` - Bahamian Dollar `BTN` - Ngultrum `BWP` - Pula `BYR` - Belarussian Ruble (2000 Series) `BYN` - Belarusian Ruble `BZD` - Belize Dollar `CAD` - Canadian Dollar `CDF` - Congolese Franc `CHE` - WIR Euro `CHF` - Swiss Franc `CHW` - WIR Franc `CLF` - Unidades de fomento `CLP` - Chilean Peso `CNY` - Yuan Renminbi `COP` - Colombian Peso `COU` - Unidad de Valor Real `CRC` - Costa Rican Colon `CUC` - Peso Convertible `CUP` - Cuban Peso `CVE` - Cape Verde Escudo `CZK` - Czech Koruna `DJF` - Djibouti Franc `DKK` - Danish Krone `DOP` - Dominican Peso `DZD` - Algerian Dinar `EGP` - Egyptian Pound `ERN` - Nakfa `ETB` - Ethiopian Birr `EUR` - Euro `FJD` - Fiji Dollar `FKP` - Falkland Islands Pound `GBP` - Pound Sterling `GEL` - Lari `GHS` - Ghana Cedi `GIP` - Gibraltar Pound `GMD` - Dalasi `GNF` - Guinea Franc `GTQ` - Quetzal `GYD` - Guyana Dollar `HKD` - Hong Kong Dollar `HNL` - Lempira `HTG` - Gourde `HUF` - Forint `IDR` - Rupiah `ILS` - New Israeli Sheqel `INR` - Indian Rupee `IQD` - Iraqi Dinar `IRR` - Iranian Rial `ISK` - Iceland Krona `JMD` - Jamaican Dollar `JOD` - Jordanian Dinar `JPY` - Yen `KES` - Kenyan Shilling `KGS` - Som `KHR` - Riel `KMF` - Comoro Franc `KPW` - North Korean Won `KRW` - Won `KWD` - Kuwaiti Dinar `KYD` - Cayman Islands Dollar `KZT` - Tenge `LAK` - Kip `LBP` - Lebanese Pound `LKR` - Sri Lanka Rupee `LRD` - Liberian Dollar `LSL` - Loti `LTL` - Lithuanian Litas `LVL` - Latvian Lats `LYD` - Libyan Dinar `MAD` - Moroccan Dirham `MDL` - Moldovan Leu `MGA` - Malagasy Ariary `MKD` - Denar `MMK` - Kyat `MNT` - Tugrik `MOP` - Pataca `MRO` - Ouguiya `MUR` - Mauritius Rupee `MVR` - Rufiyaa `MWK` - Kwacha `MXN` - Mexican Peso `MYR` - Malaysian Ringgit `MZN` - Mozambique Metical `NAD` - Namibia Dollar `NGN` - Naira `NIO` - Cordoba Oro `NOK` - Norwegian Krone `NPR` - Nepalese Rupee `NZD` - New Zealand Dollar `OMR` - Rial Omani `PAB` - Balboa `PEN` - Nuevo Sol `PGK` - Kina `PHP` - Philippine Peso `PKR` - Pakistan Rupee `PLN` - Zloty `PYG` - Guarani `QAR` - Qatari Rial `RON` - New Romanian Leu `RSD` - Serbian Dinar `RUB` - Russian Ruble `RWF` - Rwanda Franc `SAR` - Saudi Riyal `SBD` - Solomon Islands Dollar `SCR` - Seychelles Rupee `SDG` - Sudanese Pound `SEK` - Swedish Krona `SGD` - Singapore Dollar `SHP` - Saint Helena Pound `SLL` - Leone `SOS` - Somali Shilling `SRD` - Surinam Dollar `SSP` - South Sudanese Pound `STD` - Dobra `SVC` - El Salvador Colon `SYP` - Syrian Pound `SZL` - Lilangeni `THB` - Baht `TJS` - Somoni `TMT` - Turkmenistan New Manat `TND` - Tunisian Dinar `TOP` - Pa'anga `TRY` - Turkish Lira `TTD` - Trinidad and Tobago Dollar `TWD` - New Taiwan Dollar `TZS` - Tanzanian Shilling `UAH` - Hryvnia `UGX` - Uganda Shilling `USD` - US Dollar `UYI` - Uruguay Peso en Unidades Indexadas (URUIURUI) `UYU` - Peso Uruguayo `UZS` - Uzbekistan Sum `VEF` - Bolivar `VND` - Dong `VUV` - Vatu `WST` - Tala `XCD` - East Caribbean Dollar `YER` - Yemeni Rial `ZAR` - Rand `ZMK` - Zambian Kwacha (replaced January 1, 2013) `ZMW` - Zambian Kwacha `ZWL` - Zimbabwe Dollar `x46` - Other Currency (open axis tables) `XPF` - CFP Franc `CNH` - Off-shore Yuan Renminbi
	DoraEntityTypeEnum (string) or BlankEnum (any) DORA entity type classification `eba_CT:x12` - Credit institutions `eba_CT:x599` - Investment firms `eba_CT:x643` - Central counterparties (CCPs) `eba_CT:x639` - Asset management companies `eba_CT:x301` - Account information service providers `eba_CT:x302` - Electronic money institutions `eba_CT:x303` - Crypto-asset service providers `eba_CT:x304` - Central security depository `eba_CT:x305` - Trading venues `eba_CT:x306` - Trade repositories `eba_CT:x300` - Payment institution `eba_CT:x316` - Other financial entity `eba_CT:x315` - Securitisation repository `eba_CT:x314` - Crowdfunding service providers `eba_CT:x313` - Administrator of critical benchmarks `eba_CT:x312` - Credit rating agency `eba_CT:x311` - Institutions for occupational retirement provision `eba_CT:x320` - Insurance intermediaries, reinsurance intermediaries and ancillary insurance intermediaries `eba_CT:x309` - Insurance and reinsurance undertakings `eba_CT:x308` - Data reporting service providers `eba_CT:x307` - Managers of alternative investment funds `eba_CT:x318` - Non-financial entity: Other than ICT intra-group service provider `eba_CT:x317` - Non-financial entity: ICT intra-group service provider `eba_CT:x310` - Issuers of asset-referenced tokens
	DoraEntityHierarchyEnum (string) or BlankEnum (any) DORA entity hierarchy classification `eba_RP:x53` - Ultimate parent `eba_RP:x551` - Parent other than ultimate parent `eba_RP:x56` - Subsidiary `eba_RP:x21` - Entities other than entities of the group `eba_RP:x210` - Outsourcing
dora_assets_value	number or null <double> Total assets value for DORA reporting
dora_competent_authority	string <= 255 characters Competent authority overseeing this entity for DORA compliance
	DoraProviderPersonTypeEnum (string) or BlankEnum (any) Type of person for ICT third-party service providers `eba_CT:x212` - Legal person, excluding individual acting in a business capacity `eba_CT:x213` - Individual acting in a business capacity
folder	string <uuid>
parent_entity	string or null <uuid> Parent entity for branch/subsidiary relationships
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]
relationship	Array of strings <uuid> [ items <uuid > ] Type of relationship with this entity

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"default_dependency": 4,
"default_penetration": 4,
"default_maturity": 1,
"default_trust": 1,
"mission": "string",
"reference_link": "http://example.com",
"builtin": true,
"legal_identifiers": null,
"country": "AF",
"currency": "AED",
"dora_entity_type": "eba_CT:x12",
"dora_entity_hierarchy": "eba_RP:x53",
"dora_assets_value": 0.1,
"dora_competent_authority": "string",
"dora_provider_person_type": "eba_CT:x212",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"parent_entity": "92c9ade6-1fd3-4213-86a2-6043a67b6c18",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"relationship": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"is_active": true,
"default_dependency": 4,
"default_penetration": 4,
"default_maturity": 1,
"default_trust": 1,
"mission": "string",
"reference_link": "http://example.com",
"builtin": true,
"legal_identifiers": null,
"country": "AF",
"currency": "AED",
"dora_entity_type": "eba_CT:x12",
"dora_entity_hierarchy": "eba_RP:x53",
"dora_assets_value": 0.1,
"dora_competent_authority": "string",
"dora_provider_person_type": "eba_CT:x212",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"parent_entity": "92c9ade6-1fd3-4213-86a2-6043a67b6c18",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"relationship": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

entities_destroy

API endpoint that allows entities to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Entity.

Responses

entities_cascade_info_retrieve

Cascade preview:

deleted: objects actually deleted by cascade
affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Entity.

Responses

entities_object_retrieve

API endpoint that allows entities to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Entity.

Responses

entities_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:

knoxApiToken

Responses

entities_batch_create_create

Batch create multiple entities from a text list. Expected format: { "entities_text": "Entity 1\nEntity 2\nREF-001:Entity 3", "folder": "folder-uuid" } Lines can optionally have a ref_id prefix (REF-001:Entity Name). Entities with the same name in the folder will be skipped.

Authorizations:

knoxApiToken

Responses

entities_country_retrieve

API endpoint that allows entities to be viewed or edited.

Authorizations:

knoxApiToken

Responses

entities_currency_retrieve

API endpoint that allows entities to be viewed or edited.

Authorizations:

knoxApiToken

Responses

entities_dora_entity_hierarchy_retrieve

API endpoint that allows entities to be viewed or edited.

Authorizations:

knoxApiToken

Responses

entities_dora_entity_type_retrieve

API endpoint that allows entities to be viewed or edited.

Authorizations:

knoxApiToken

Responses

entities_dora_provider_person_type_retrieve

API endpoint that allows entities to be viewed or edited.

Authorizations:

knoxApiToken

Responses

entities_dora_roi_lint_retrieve

Validate DORA ROI requirements and return linting results.

Authorizations:

knoxApiToken

Responses

entities_generate_dora_roi_retrieve

Generate DORA Register of Information (ROI) as a zip file containing CSV data.

This generates a comprehensive DORA ROI export containing multiple CSV reports:

b_01.01: Main entity information
b_01.02: Entity register (main entity + branches)
b_01.03: Branches register
b_02.01-03: Contractual arrangements
b_03.01-03: Signing entities and providers
b_04.01: Entities using ICT services
b_05.01-02: Provider details and supply chains
b_06.01: Critical functions register
b_07.01: Assessment of ICT services
b_99.01: Aggregation report
FilingIndicators.csv: Template inclusion indicators
parameters.csv: Report metadata and configuration
META-INF/reportPackage.json: XBRL report package metadata
reports/report.json: XBRL CSV configuration and taxonomy references

Authorizations:

knoxApiToken

Responses

entities_graph_retrieve

Generate graph data for entities, showing:

Entity hierarchy (parent-child relationships)
Solutions provided by entities
Contracts between entities
Assets linked to solutions
Asset hierarchy (parent-child asset relationships)

Authorizations:

knoxApiToken

Responses

filtering-labels

filtering_labels_list

Override the list method to inject optimized data into the serializer context.

Authorizations:

knoxApiToken

query Parameters

folder	Array of strings <uuid> [ items <uuid > ]
id	Array of strings <uuid> [ items <uuid > ] Multiple values may be separated by commas.
limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
search	string A search term.

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"folder": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"label": "string"
}
]
}

filtering_labels_create

API endpoint that allows labels to be viewed or edited.

Authorizations:

knoxApiToken

Request Body schema:
application/json
required

label

required

string <= 100 characters ^[\w-]{1,36}$

Responses

Request samples

Payload

Content type

application/json

{"label": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"label": "string"
}

filtering_labels_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this filtering label.

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"folder": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"label": "string"
}

filtering_labels_update

API endpoint that allows labels to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this filtering label.

Request Body schema:
application/json
required

label

required

string <= 100 characters ^[\w-]{1,36}$

Responses

Request samples

Payload

Content type

application/json

{"label": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"label": "string"
}

filtering_labels_partial_update

API endpoint that allows labels to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this filtering label.

Request Body schema:
application/json

label

string <= 100 characters ^[\w-]{1,36}$

Responses

Request samples

Payload

Content type

application/json

{"label": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"label": "string"
}

filtering_labels_destroy

API endpoint that allows labels to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this filtering label.

Responses

filtering_labels_cascade_info_retrieve

Cascade preview:

deleted: objects actually deleted by cascade
affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this filtering label.

Responses

filtering_labels_object_retrieve

API endpoint that allows labels to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this filtering label.

Responses

filtering_labels_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:

knoxApiToken

Responses

folders

folders_list

Override the list method to inject optimized data into the serializer context.

Authorizations:

knoxApiToken

query Parameters

content_type	Array of strings
filtering_labels	Array of strings <uuid> [ items <uuid > ]
id	Array of strings <uuid> [ items <uuid > ] Multiple values may be separated by commas.
limit	integer Number of results to return per page.
name	string
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
owned	boolean owned
owner	Array of strings <uuid> [ items <uuid > ]
parent_folder	Array of strings <uuid> [ items <uuid > ]
search	string A search term.

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"parent_folder": "string",
"filtering_labels": ["string"
],
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"builtin": true,
"create_iam_groups": true
}
]
}

folders_create

API endpoint that allows folders to be viewed or edited.

Authorizations:

knoxApiToken

Request Body schema:
application/json
required

is_published	boolean (Published)
name required	string <= 200 characters
description	string or null
create_iam_groups	boolean Automatically provision IAM groups for domain folders.
parent_folder	string or null <uuid>
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"create_iam_groups": true,
"parent_folder": "af1fd540-5590-49cd-a301-88b2132994d5",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"create_iam_groups": true,
"parent_folder": "af1fd540-5590-49cd-a301-88b2132994d5",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

folders_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Folder.

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"parent_folder": "string",
"filtering_labels": ["string"
],
"content_type": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"builtin": true,
"create_iam_groups": true
}

folders_update

API endpoint that allows folders to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Folder.

Request Body schema:
application/json
required

is_published	boolean (Published)
name required	string <= 200 characters
description	string or null
create_iam_groups	boolean Automatically provision IAM groups for domain folders.
parent_folder	string or null <uuid>
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"create_iam_groups": true,
"parent_folder": "af1fd540-5590-49cd-a301-88b2132994d5",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"create_iam_groups": true,
"parent_folder": "af1fd540-5590-49cd-a301-88b2132994d5",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

folders_partial_update

API endpoint that allows folders to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Folder.

Request Body schema:
application/json

is_published	boolean (Published)
name	string <= 200 characters
description	string or null
create_iam_groups	boolean Automatically provision IAM groups for domain folders.
parent_folder	string or null <uuid>
filtering_labels	Array of strings <uuid> (Labels) [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"create_iam_groups": true,
"parent_folder": "af1fd540-5590-49cd-a301-88b2132994d5",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"create_iam_groups": true,
"parent_folder": "af1fd540-5590-49cd-a301-88b2132994d5",
"filtering_labels": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

folders_destroy

API endpoint that allows folders to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Folder.

Responses

folders_cascade_info_retrieve

Cascade preview:

deleted: objects actually deleted by cascade
affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Folder.

Responses

folders_export_retrieve

Export the domain as a zip file containing a JSON dump of all objects and their relationships

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Folder.

Responses

folders_object_retrieve

API endpoint that allows folders to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Folder.

Responses

folders_quality_check_retrieve_2

Returns the quality check of assessments for a specific folder.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Folder.

Responses

folders_users_list

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

query Parameters

limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
search	string A search term.

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "string",
"first_name": "string",
"last_name": "string",
"is_active": true,
"roles": "string"
}
]
}

folders_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:

knoxApiToken

Responses

folders_get_accessible_objects_retrieve

Return the list of folders, perimeters, frameworks and risk matrices the current user can access, based on their role assignments.

Authorizations:

knoxApiToken

Responses

folders_ids_retrieve

API endpoint that allows folders to be viewed or edited.

Authorizations:

knoxApiToken

Responses

folders_import_create

Handle file upload and initiate import process.

Authorizations:

knoxApiToken

Responses

folders_import_dummy_create

API endpoint that allows folders to be viewed or edited.

Authorizations:

knoxApiToken

Responses

folders_my_assignments_retrieve

API endpoint that allows folders to be viewed or edited.

Authorizations:

knoxApiToken

Responses

folders_org_tree_retrieve

Returns the tree of domains and perimeters

Authorizations:

knoxApiToken

Responses

folders_quality_check_retrieve

Returns the quality check of assessments grouped by folder.

Authorizations:

knoxApiToken

Responses

library-filtering-labels

library_filtering_labels_list

Override the list method to inject optimized data into the serializer context.

Authorizations:

knoxApiToken

query Parameters

folder	Array of strings <uuid> [ items <uuid > ]
id	Array of strings <uuid> [ items <uuid > ] Multiple values may be separated by commas.
limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
search	string A search term.

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"folder": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"label": "string"
}
]
}

library_filtering_labels_create

API endpoint that allows library labels to be viewed or edited.

Authorizations:

knoxApiToken

Request Body schema:
application/json
required

label

required

string <= 100 characters ^[\w-]{1,36}$

Responses

Request samples

Payload

Content type

application/json

{"label": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"label": "string"
}

library_filtering_labels_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this library filtering label.

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"folder": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"label": "string"
}

library_filtering_labels_update

API endpoint that allows library labels to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this library filtering label.

Request Body schema:
application/json
required

label

required

string <= 100 characters ^[\w-]{1,36}$

Responses

Request samples

Payload

Content type

application/json

{"label": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"label": "string"
}

library_filtering_labels_partial_update

API endpoint that allows library labels to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this library filtering label.

Request Body schema:
application/json

label

string <= 100 characters ^[\w-]{1,36}$

Responses

Request samples

Payload

Content type

application/json

{"label": "string"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"label": "string"
}

library_filtering_labels_destroy

API endpoint that allows library labels to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this library filtering label.

Responses

library_filtering_labels_cascade_info_retrieve

Cascade preview:

deleted: objects actually deleted by cascade
affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this library filtering label.

Responses

library_filtering_labels_object_retrieve

API endpoint that allows library labels to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this library filtering label.

Responses

library_filtering_labels_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:

knoxApiToken

Responses

perimeters

perimeters_list

Override the list method to inject optimized data into the serializer context.

Authorizations:

knoxApiToken

query Parameters

campaigns	Array of strings <uuid> [ items <uuid > ]
folder	Array of strings <uuid> [ items <uuid > ]
id	Array of strings <uuid> [ items <uuid > ] Multiple values may be separated by commas.
lc_status	Array of strings (Status) Items Enum: "dropped" "eol" "in_design" "in_dev" "in_prod" "undefined" `undefined` - Undefined `in_design` - Design `in_dev` - Development `in_prod` - Production `eol` - EndOfLife `dropped` - Dropped
limit	integer Number of results to return per page.
name	string
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
search	string A search term.

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"folder": "string",
"lc_status": "string",
"default_assignee": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string"
}
]
}

perimeters_create

API endpoint that allows perimeters to be viewed or edited.

Authorizations:

knoxApiToken

Request Body schema:
application/json
required

is_published	boolean (Published)
name required	string <= 200 characters
description	string or null
ref_id	string or null (Reference id) <= 100 characters
lc_status	string (Status) Enum: "undefined" "in_design" "in_dev" "in_prod" "eol" "dropped" `undefined` - Undefined `in_design` - Design `in_dev` - Development `in_prod` - Production `eol` - EndOfLife `dropped` - Dropped
folder	string <uuid>
default_assignee	Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"lc_status": "undefined",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"default_assignee": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"lc_status": "undefined",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"default_assignee": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

perimeters_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Perimeter.

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"path": "string",
"folder": "string",
"lc_status": "string",
"default_assignee": ["string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string"
}

perimeters_update

API endpoint that allows perimeters to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Perimeter.

Request Body schema:
application/json
required

is_published	boolean (Published)
name required	string <= 200 characters
description	string or null
ref_id	string or null (Reference id) <= 100 characters
lc_status	string (Status) Enum: "undefined" "in_design" "in_dev" "in_prod" "eol" "dropped" `undefined` - Undefined `in_design` - Design `in_dev` - Development `in_prod` - Production `eol` - EndOfLife `dropped` - Dropped
folder	string <uuid>
default_assignee	Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"lc_status": "undefined",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"default_assignee": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"lc_status": "undefined",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"default_assignee": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

perimeters_partial_update

API endpoint that allows perimeters to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Perimeter.

Request Body schema:
application/json

is_published	boolean (Published)
name	string <= 200 characters
description	string or null
ref_id	string or null (Reference id) <= 100 characters
lc_status	string (Status) Enum: "undefined" "in_design" "in_dev" "in_prod" "eol" "dropped" `undefined` - Undefined `in_design` - Design `in_dev` - Development `in_prod` - Production `eol` - EndOfLife `dropped` - Dropped
folder	string <uuid>
default_assignee	Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"lc_status": "undefined",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"default_assignee": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "string",
"description": "string",
"ref_id": "string",
"lc_status": "undefined",
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
"default_assignee": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

perimeters_destroy

API endpoint that allows perimeters to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Perimeter.

Responses

perimeters_cascade_info_retrieve

Cascade preview:

deleted: objects actually deleted by cascade
affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Perimeter.

Responses

perimeters_object_retrieve

API endpoint that allows perimeters to be viewed or edited.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Perimeter.

Responses

perimeters_quality_check_retrieve_2

Returns the quality check of the perimeter

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this Perimeter.

Responses

perimeters_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:

knoxApiToken

Responses

perimeters_ids_retrieve

API endpoint that allows perimeters to be viewed or edited.

Authorizations:

knoxApiToken

Responses

perimeters_lc_status_retrieve

API endpoint that allows perimeters to be viewed or edited.

Authorizations:

knoxApiToken

Responses

perimeters_names_retrieve

API endpoint that allows perimeters to be viewed or edited.

Authorizations:

knoxApiToken

Responses

perimeters_quality_check_retrieve

Returns the quality check of the perimeters

Authorizations:

knoxApiToken

Responses

settings

settings_feature_flags_retrieve

Authorizations:

knoxApiToken

Responses

Response samples

Content type

application/json

{"xrays": true,
"incidents": true,
"tasks": true,
"risk_acceptances": true,
"exceptions": true,
"follow_up": true,
"ebiosrm": true,
"scoring_assistant": true,
"vulnerabilities": true,
"compliance": true,
"tprm": true,
"privacy": true,
"experimental": true,
"inherent_risk": false,
"organisation_objectives": true,
"organisation_issues": true,
"quantitative_risk_studies": true,
"terminologies": true,
"bia": true,
"project_management": false,
"contracts": false,
"reports": false,
"validation_flows": false,
"outgoing_webhooks": false,
"metrology": true,
"personal_data": true,
"purposes": true,
"right_requests": true,
"data_breaches": true,
"auditee_mode": false,
"advanced_analytics": false,
"comments": true,
"journeys": true,
"policy_documents": true
}

settings_feature_flags_update

Authorizations:

knoxApiToken

Request Body schema:
application/json

xrays	boolean Default: true
incidents	boolean Default: true
tasks	boolean Default: true
risk_acceptances	boolean Default: true
exceptions	boolean Default: true
follow_up	boolean Default: true
ebiosrm	boolean Default: true
scoring_assistant	boolean Default: true
vulnerabilities	boolean Default: true
compliance	boolean Default: true
tprm	boolean Default: true
privacy	boolean Default: true
experimental	boolean Default: true
inherent_risk	boolean Default: false
organisation_objectives	boolean Default: true
organisation_issues	boolean Default: true
quantitative_risk_studies	boolean Default: true
terminologies	boolean Default: true
bia	boolean Default: true
project_management	boolean Default: false
contracts	boolean Default: false
reports	boolean Default: false
validation_flows	boolean Default: false
outgoing_webhooks	boolean Default: false
metrology	boolean Default: true
personal_data	boolean Default: true
purposes	boolean Default: true
right_requests	boolean Default: true
data_breaches	boolean Default: true
auditee_mode	boolean Default: false
advanced_analytics	boolean Default: false
comments	boolean Default: true
journeys	boolean Default: true
policy_documents	boolean Default: true

Responses

Request samples

Payload

Content type

application/json

{"xrays": true,
"incidents": true,
"tasks": true,
"risk_acceptances": true,
"exceptions": true,
"follow_up": true,
"ebiosrm": true,
"scoring_assistant": true,
"vulnerabilities": true,
"compliance": true,
"tprm": true,
"privacy": true,
"experimental": true,
"inherent_risk": false,
"organisation_objectives": true,
"organisation_issues": true,
"quantitative_risk_studies": true,
"terminologies": true,
"bia": true,
"project_management": false,
"contracts": false,
"reports": false,
"validation_flows": false,
"outgoing_webhooks": false,
"metrology": true,
"personal_data": true,
"purposes": true,
"right_requests": true,
"data_breaches": true,
"auditee_mode": false,
"advanced_analytics": false,
"comments": true,
"journeys": true,
"policy_documents": true
}

Response samples

Content type

application/json

{"xrays": true,
"incidents": true,
"tasks": true,
"risk_acceptances": true,
"exceptions": true,
"follow_up": true,
"ebiosrm": true,
"scoring_assistant": true,
"vulnerabilities": true,
"compliance": true,
"tprm": true,
"privacy": true,
"experimental": true,
"inherent_risk": false,
"organisation_objectives": true,
"organisation_issues": true,
"quantitative_risk_studies": true,
"terminologies": true,
"bia": true,
"project_management": false,
"contracts": false,
"reports": false,
"validation_flows": false,
"outgoing_webhooks": false,
"metrology": true,
"personal_data": true,
"purposes": true,
"right_requests": true,
"data_breaches": true,
"auditee_mode": false,
"advanced_analytics": false,
"comments": true,
"journeys": true,
"policy_documents": true
}

settings_feature_flags_partial_update

Authorizations:

knoxApiToken

Request Body schema:
application/json

xrays	boolean Default: true
incidents	boolean Default: true
tasks	boolean Default: true
risk_acceptances	boolean Default: true
exceptions	boolean Default: true
follow_up	boolean Default: true
ebiosrm	boolean Default: true
scoring_assistant	boolean Default: true
vulnerabilities	boolean Default: true
compliance	boolean Default: true
tprm	boolean Default: true
privacy	boolean Default: true
experimental	boolean Default: true
inherent_risk	boolean Default: false
organisation_objectives	boolean Default: true
organisation_issues	boolean Default: true
quantitative_risk_studies	boolean Default: true
terminologies	boolean Default: true
bia	boolean Default: true
project_management	boolean Default: false
contracts	boolean Default: false
reports	boolean Default: false
validation_flows	boolean Default: false
outgoing_webhooks	boolean Default: false
metrology	boolean Default: true
personal_data	boolean Default: true
purposes	boolean Default: true
right_requests	boolean Default: true
data_breaches	boolean Default: true
auditee_mode	boolean Default: false
advanced_analytics	boolean Default: false
comments	boolean Default: true
journeys	boolean Default: true
policy_documents	boolean Default: true

Responses

Request samples

Payload

Content type

application/json

{"xrays": true,
"incidents": true,
"tasks": true,
"risk_acceptances": true,
"exceptions": true,
"follow_up": true,
"ebiosrm": true,
"scoring_assistant": true,
"vulnerabilities": true,
"compliance": true,
"tprm": true,
"privacy": true,
"experimental": true,
"inherent_risk": false,
"organisation_objectives": true,
"organisation_issues": true,
"quantitative_risk_studies": true,
"terminologies": true,
"bia": true,
"project_management": false,
"contracts": false,
"reports": false,
"validation_flows": false,
"outgoing_webhooks": false,
"metrology": true,
"personal_data": true,
"purposes": true,
"right_requests": true,
"data_breaches": true,
"auditee_mode": false,
"advanced_analytics": false,
"comments": true,
"journeys": true,
"policy_documents": true
}

Response samples

Content type

application/json

{"xrays": true,
"incidents": true,
"tasks": true,
"risk_acceptances": true,
"exceptions": true,
"follow_up": true,
"ebiosrm": true,
"scoring_assistant": true,
"vulnerabilities": true,
"compliance": true,
"tprm": true,
"privacy": true,
"experimental": true,
"inherent_risk": false,
"organisation_objectives": true,
"organisation_issues": true,
"quantitative_risk_studies": true,
"terminologies": true,
"bia": true,
"project_management": false,
"contracts": false,
"reports": false,
"validation_flows": false,
"outgoing_webhooks": false,
"metrology": true,
"personal_data": true,
"purposes": true,
"right_requests": true,
"data_breaches": true,
"auditee_mode": false,
"advanced_analytics": false,
"comments": true,
"journeys": true,
"policy_documents": true
}

settings_general_retrieve

Authorizations:

knoxApiToken

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "general",
"value": null
}

settings_general_update

Authorizations:

knoxApiToken

Request Body schema:
application/json

conversion_rate	number <double> Default: 1
value	any

Responses

Request samples

Payload

Content type

application/json

{"conversion_rate": 1,
"value": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "general",
"value": null
}

settings_general_partial_update

Authorizations:

knoxApiToken

Request Body schema:
application/json

conversion_rate	number <double> Default: 1
value	any

Responses

Request samples

Payload

Content type

application/json

{"conversion_rate": 1,
"value": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "general",
"value": null
}

settings_general_default_language_retrieve

Returns the configured default language. Falls back to English if unset or invalid.

Authorizations:

knoxApiTokenNone

Responses

settings_general_default_language_retrieve_2

Authorizations:

knoxApiToken

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "general",
"value": null
}

settings_general_ebios_radar_parameters_retrieve

Authorizations:

knoxApiToken

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "general",
"value": null
}

settings_general_force_language_create

Authorizations:

knoxApiToken

Request Body schema:
application/json

conversion_rate	number <double> Default: 1
value	any

Responses

Request samples

Payload

Content type

application/json

{"conversion_rate": 1,
"value": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "general",
"value": null
}

settings_general_interface_settings_retrieve

Authorizations:

knoxApiToken

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "general",
"value": null
}

settings_general_notifications_settings_retrieve

Authorizations:

knoxApiToken

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "general",
"value": null
}

settings_general_object_retrieve

Authorizations:

knoxApiToken

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "general",
"value": null
}

settings_general_security_objective_scale_retrieve

Authorizations:

knoxApiToken

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "general",
"value": null
}

settings_global_list

Authorizations:

knoxApiToken

query Parameters

limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "general",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

settings_global_create

Authorizations:

knoxApiToken

Request Body schema:
application/json

name	string (NameEnum) Enum: "general" "sso" "feature-flags" `general` - General `sso` - SSO `feature-flags` - Feature Flags

Responses

Request samples

Payload

Content type

application/json

{"name": "general"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "general",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

settings_global_retrieve

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this global settings.

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "general",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

settings_global_update

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this global settings.

Request Body schema:
application/json

name	string (NameEnum) Enum: "general" "sso" "feature-flags" `general` - General `sso` - SSO `feature-flags` - Feature Flags

Responses

Request samples

Payload

Content type

application/json

{"name": "general"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "general",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

settings_global_partial_update

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this global settings.

Request Body schema:
application/json

name	string (NameEnum) Enum: "general" "sso" "feature-flags" `general` - General `sso` - SSO `feature-flags` - Feature Flags

Responses

Request samples

Payload

Content type

application/json

{"name": "general"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "general",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

settings_global_destroy

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this global settings.

Responses

settings_sso_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:

knoxApiToken

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"provider": "string",
"is_enabled": true,
"force_sso": true
}

settings_sso_update

Authorizations:

knoxApiToken

Request Body schema:
application/json

is_enabled	boolean
force_sso	boolean
provider	string or null
provider_id	string or null
client_id	string or null
secret	string or null
server_url	string or null
	(TokenAuthMethodEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
oauth_pkce_enabled	boolean Default: false
provider_name	string or null
attribute_mapping_uid	Array of strings or null or null
attribute_mapping_email_verified	Array of strings or null or null
attribute_mapping_email	Array of strings or null or null
idp_entity_id	string or null
metadata_url	string or null
sso_url	string or null
slo_url	string or null
x509cert	string or null
sp_entity_id	string or null
allow_repeat_attribute_name	boolean
allow_single_label_domains	boolean
authn_request_signed	boolean
digest_algorithm	string or null
logout_request_signed	boolean
logout_response_signed	boolean
metadata_signed	boolean
name_id_encrypted	boolean
reject_deprecated_algorithm	boolean
reject_idp_initiated_sso	boolean
signature_algorithm	string or null
want_assertion_encrypted	boolean
want_assertion_signed	boolean
want_attribute_statement	boolean
want_message_signed	boolean
want_name_id	boolean
want_name_id_encrypted	boolean
sp_x509cert	string or null
sp_private_key	string or null
is_published	boolean (Published)
name	string (NameEnum) Enum: "general" "sso" "feature-flags" `general` - General `sso` - SSO `feature-flags` - Feature Flags
key	string <= 191 characters Key
settings	any
folder	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"is_enabled": true,
"force_sso": true,
"provider": "string",
"provider_id": "string",
"client_id": "string",
"secret": "string",
"server_url": "string",
"token_auth_method": "client_secret_basic",
"oauth_pkce_enabled": false,
"provider_name": "string",
"attribute_mapping_uid": ["string"
],
"attribute_mapping_email_verified": ["string"
],
"attribute_mapping_email": ["string"
],
"idp_entity_id": "string",
"metadata_url": "string",
"sso_url": "string",
"slo_url": "string",
"x509cert": "string",
"sp_entity_id": "string",
"allow_repeat_attribute_name": true,
"allow_single_label_domains": true,
"authn_request_signed": true,
"digest_algorithm": "string",
"logout_request_signed": true,
"logout_response_signed": true,
"metadata_signed": true,
"name_id_encrypted": true,
"reject_deprecated_algorithm": true,
"reject_idp_initiated_sso": true,
"signature_algorithm": "string",
"want_assertion_encrypted": true,
"want_assertion_signed": true,
"want_attribute_statement": true,
"want_message_signed": true,
"want_name_id": true,
"want_name_id_encrypted": true,
"sp_x509cert": "string",
"sp_private_key": "string",
"is_published": true,
"name": "general",
"key": "string",
"settings": null,
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_enabled": true,
"force_sso": true,
"provider": "string",
"provider_id": "string",
"client_id": "string",
"server_url": "string",
"token_auth_method": "client_secret_basic",
"oauth_pkce_enabled": false,
"provider_name": "string",
"attribute_mapping_uid": ["string"
],
"attribute_mapping_email_verified": ["string"
],
"attribute_mapping_email": ["string"
],
"idp_entity_id": "string",
"metadata_url": "string",
"sso_url": "string",
"slo_url": "string",
"x509cert": "string",
"sp_entity_id": "string",
"allow_repeat_attribute_name": true,
"allow_single_label_domains": true,
"authn_request_signed": true,
"digest_algorithm": "string",
"logout_request_signed": true,
"logout_response_signed": true,
"metadata_signed": true,
"name_id_encrypted": true,
"reject_deprecated_algorithm": true,
"reject_idp_initiated_sso": true,
"signature_algorithm": "string",
"want_assertion_encrypted": true,
"want_assertion_signed": true,
"want_attribute_statement": true,
"want_message_signed": true,
"want_name_id": true,
"want_name_id_encrypted": true,
"sp_x509cert": "string",
"oidc_has_secret": true,
"saml_has_sp_private_key": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "general",
"key": "string",
"settings": null,
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

settings_sso_partial_update

Authorizations:

knoxApiToken

Request Body schema:
application/json

is_enabled	boolean
force_sso	boolean
provider	string or null
provider_id	string or null
client_id	string or null
secret	string or null
server_url	string or null
	(TokenAuthMethodEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
oauth_pkce_enabled	boolean Default: false
provider_name	string or null
attribute_mapping_uid	Array of strings or null or null
attribute_mapping_email_verified	Array of strings or null or null
attribute_mapping_email	Array of strings or null or null
idp_entity_id	string or null
metadata_url	string or null
sso_url	string or null
slo_url	string or null
x509cert	string or null
sp_entity_id	string or null
allow_repeat_attribute_name	boolean
allow_single_label_domains	boolean
authn_request_signed	boolean
digest_algorithm	string or null
logout_request_signed	boolean
logout_response_signed	boolean
metadata_signed	boolean
name_id_encrypted	boolean
reject_deprecated_algorithm	boolean
reject_idp_initiated_sso	boolean
signature_algorithm	string or null
want_assertion_encrypted	boolean
want_assertion_signed	boolean
want_attribute_statement	boolean
want_message_signed	boolean
want_name_id	boolean
want_name_id_encrypted	boolean
sp_x509cert	string or null
sp_private_key	string or null
is_published	boolean (Published)
name	string (NameEnum) Enum: "general" "sso" "feature-flags" `general` - General `sso` - SSO `feature-flags` - Feature Flags
key	string <= 191 characters Key
settings	any
folder	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"is_enabled": true,
"force_sso": true,
"provider": "string",
"provider_id": "string",
"client_id": "string",
"secret": "string",
"server_url": "string",
"token_auth_method": "client_secret_basic",
"oauth_pkce_enabled": false,
"provider_name": "string",
"attribute_mapping_uid": ["string"
],
"attribute_mapping_email_verified": ["string"
],
"attribute_mapping_email": ["string"
],
"idp_entity_id": "string",
"metadata_url": "string",
"sso_url": "string",
"slo_url": "string",
"x509cert": "string",
"sp_entity_id": "string",
"allow_repeat_attribute_name": true,
"allow_single_label_domains": true,
"authn_request_signed": true,
"digest_algorithm": "string",
"logout_request_signed": true,
"logout_response_signed": true,
"metadata_signed": true,
"name_id_encrypted": true,
"reject_deprecated_algorithm": true,
"reject_idp_initiated_sso": true,
"signature_algorithm": "string",
"want_assertion_encrypted": true,
"want_assertion_signed": true,
"want_attribute_statement": true,
"want_message_signed": true,
"want_name_id": true,
"want_name_id_encrypted": true,
"sp_x509cert": "string",
"sp_private_key": "string",
"is_published": true,
"name": "general",
"key": "string",
"settings": null,
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_enabled": true,
"force_sso": true,
"provider": "string",
"provider_id": "string",
"client_id": "string",
"server_url": "string",
"token_auth_method": "client_secret_basic",
"oauth_pkce_enabled": false,
"provider_name": "string",
"attribute_mapping_uid": ["string"
],
"attribute_mapping_email_verified": ["string"
],
"attribute_mapping_email": ["string"
],
"idp_entity_id": "string",
"metadata_url": "string",
"sso_url": "string",
"slo_url": "string",
"x509cert": "string",
"sp_entity_id": "string",
"allow_repeat_attribute_name": true,
"allow_single_label_domains": true,
"authn_request_signed": true,
"digest_algorithm": "string",
"logout_request_signed": true,
"logout_response_signed": true,
"metadata_signed": true,
"name_id_encrypted": true,
"reject_deprecated_algorithm": true,
"reject_idp_initiated_sso": true,
"signature_algorithm": "string",
"want_assertion_encrypted": true,
"want_assertion_signed": true,
"want_attribute_statement": true,
"want_message_signed": true,
"want_name_id": true,
"want_name_id_encrypted": true,
"sp_x509cert": "string",
"oidc_has_secret": true,
"saml_has_sp_private_key": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_published": true,
"name": "general",
"key": "string",
"settings": null,
"folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5"
}

settings_sso_cascade_info_retrieve

Cascade preview:

deleted: objects actually deleted by cascade
affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)

Authorizations:

knoxApiToken

Responses

settings_sso_info_retrieve

API endpoint that returns the CSRF token.

Authorizations:

knoxApiTokenNone

Responses

settings_sso_object_retrieve

Authorizations:

knoxApiToken

Responses

settings_sso_provider_retrieve

Authorizations:

knoxApiToken

Responses

terminologies

terminologies_list

Override the list method to inject optimized data into the serializer context.

Authorizations:

knoxApiToken

query Parameters

builtin	boolean
field_path	Array of strings Items Enum: "accreditation.category" "accreditation.status" "entity.relationship" "metric_definition.unit" "qualifications" "ro_to.risk_origin" `ro_to.risk_origin` - ro_to/risk_origin `qualifications` - qualifications `accreditation.status` - accreditationStatus `accreditation.category` - accreditationCategory `entity.relationship` - entityRelationship `metric_definition.unit` - metricUnit
folder	Array of strings <uuid> [ items <uuid > ]
id	Array of strings <uuid> [ items <uuid > ] Multiple values may be separated by commas.
is_visible	boolean
limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.
search	string A search term.

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"field_path": "string",
"translated_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"is_published": true,
"builtin": true,
"is_visible": true,
"translations": null
}
]
}

terminologies_create

Authorizations:

knoxApiToken

Request Body schema:
application/json
required

name required	string <= 200 characters
description	string or null
field_path required	string (FieldPathEnum) Enum: "ro_to.risk_origin" "qualifications" "accreditation.status" "accreditation.category" "entity.relationship" "metric_definition.unit" `ro_to.risk_origin` - ro_to/risk_origin `qualifications` - qualifications `accreditation.status` - accreditationStatus `accreditation.category` - accreditationCategory `entity.relationship` - entityRelationship `metric_definition.unit` - metricUnit
is_visible	boolean Indicates if the terminology is visible in the UI
translations	any or null JSON field to store translations for different languages

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"field_path": "ro_to.risk_origin",
"is_visible": true,
"translations": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"builtin": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"field_path": "ro_to.risk_origin",
"is_visible": true,
"translations": null
}

terminologies_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this terminology.

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"field_path": "string",
"translated_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"is_published": true,
"builtin": true,
"is_visible": true,
"translations": null
}

terminologies_update

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this terminology.

Request Body schema:
application/json
required

name required	string <= 200 characters
description	string or null
field_path required	string (FieldPathEnum) Enum: "ro_to.risk_origin" "qualifications" "accreditation.status" "accreditation.category" "entity.relationship" "metric_definition.unit" `ro_to.risk_origin` - ro_to/risk_origin `qualifications` - qualifications `accreditation.status` - accreditationStatus `accreditation.category` - accreditationCategory `entity.relationship` - entityRelationship `metric_definition.unit` - metricUnit
is_visible	boolean Indicates if the terminology is visible in the UI
translations	any or null JSON field to store translations for different languages

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"field_path": "ro_to.risk_origin",
"is_visible": true,
"translations": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"builtin": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"field_path": "ro_to.risk_origin",
"is_visible": true,
"translations": null
}

terminologies_partial_update

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this terminology.

Request Body schema:
application/json

name	string <= 200 characters
description	string or null
field_path	string (FieldPathEnum) Enum: "ro_to.risk_origin" "qualifications" "accreditation.status" "accreditation.category" "entity.relationship" "metric_definition.unit" `ro_to.risk_origin` - ro_to/risk_origin `qualifications` - qualifications `accreditation.status` - accreditationStatus `accreditation.category` - accreditationCategory `entity.relationship` - entityRelationship `metric_definition.unit` - metricUnit
is_visible	boolean Indicates if the terminology is visible in the UI
translations	any or null JSON field to store translations for different languages

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"field_path": "ro_to.risk_origin",
"is_visible": true,
"translations": null
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"builtin": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string",
"field_path": "ro_to.risk_origin",
"is_visible": true,
"translations": null
}

terminologies_destroy

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this terminology.

Responses

terminologies_cascade_info_retrieve

Cascade preview:

deleted: objects actually deleted by cascade
affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this terminology.

Responses

terminologies_object_retrieve

Authorizations:

knoxApiToken

path Parameters

required

string <uuid>

A UUID string identifying this terminology.

Responses

terminologies_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

CISO Assistant API — Organization (0.7.0)

entities

entities_list

Authorizations:

query Parameters

Responses

Response samples

entities_create

Authorizations:

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Responses

Request samples

Response samples

entities_retrieve

Authorizations:

path Parameters

Responses

Response samples

entities_update

Authorizations:

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Responses

Request samples

Response samples

entities_partial_update

Authorizations:

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

entities_destroy

Authorizations:

path Parameters

Responses

entities_cascade_info_retrieve

Authorizations:

path Parameters

Responses

entities_object_retrieve

Authorizations:

path Parameters

Responses

entities_batch_action_create

Authorizations:

Responses

entities_batch_create_create

Authorizations:

Responses

entities_country_retrieve

Authorizations:

Responses

entities_currency_retrieve

Authorizations:

Responses

entities_dora_entity_hierarchy_retrieve

Authorizations:

Responses

entities_dora_entity_type_retrieve

Authorizations:

Responses

entities_dora_provider_person_type_retrieve

Authorizations:

Responses

entities_dora_roi_lint_retrieve

Authorizations:

Responses

entities_generate_dora_roi_retrieve

Authorizations:

Responses

entities_graph_retrieve

Authorizations:

Responses

filtering-labels

filtering_labels_list

Authorizations:

query Parameters

Responses

Response samples

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json