Ostrich Birdseye API (1.0.0)

Download OpenAPI specification:Download

API for Ostrich Birdseye

Get Auth Token

Generates a JWT from an API Key

Request Body schema: application/json
required

The API Key to generate a token for

apiKey

required

string

Responses

Request samples

Payload

Content type

application/json

{"apiKey": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"response": {"token": "string"
}
}

Get Business Units

Retrieves summary info for all business units for the authenticated token

Authorizations:

Bearer

Responses

Response samples

200

Content type

application/json

{"message": "string",
"response": {"businessUnits": [{"businessUnitId": "kwZhJvbywXQQnImPQ6Cz",
"name": "My Business Unit",
"businessUnits": [{"businessUnitId": "abCdEfghiJIIzMmCD3Ez",
"name": "My Business Unit"
}
]
}
]
}
}

Get Business Unit

Retrieves the details for a specific business unit

Authorizations:

Bearer

path Parameters

businessUnitId

required

string

The ID of the business unit

Responses

Response samples

200

Content type

application/json

{"message": "string",
"response": {"businessUnitId": "kwZhJvbywXQQnImPQ6Cz",
"name": "My Business Unit",
"businessUnits": [{"businessUnitId": "abCdEfghiJIIzMmCD3Ez",
"name": "My Business Unit"
}
]
}
}

Get Assessments

Retrieves summaries of the assessments for a business unit

Authorizations:

Bearer

path Parameters

businessUnitId

required

string

The ID of the business unit

Responses

Response samples

200

Content type

application/json

{"message": "string",
"response": {"assessments": [{"businessUnitId": "kwZhJvbywXQQnImPQ6Cz",
"businessUnitName": "My Business Unit 1",
"assessmentId": "abCdEfghiJIIzMmCD3Ez",
"assessmentName": "My Assessment 1",
"assessments": [{"businessUnitId": "abCdEfghiJIIzMmCD3Ez",
"businessUnitName": "My Business Unit 2",
"assessmentId": "deFGEfghxYZZzMmCD3Ez",
"assessmentName": "My Assessment 2",
"assessmentTypeId": "abCdEfghiJIIzMmCD3Ez"
}
]
}
]
}
}

Get Assessment

Retrieves details of an assessment in a business unit

Authorizations:

Bearer

path Parameters

businessUnitId required	string The ID of the business unit
assessmentId required	string The ID of the assessment to retrieve details of

Responses

Response samples

200

Content type

application/json

{"message": "string",
"response": {"assessmentId": "kwZhJvbywXQQnImPQ6Cz",
"assessmentName": "My Assessment",
"version": "1.0",
"assessmentTypeId": "abCdEfghiJIIzMmCD3Ez",
"subAssessments": [{"assessmentId": "abCdEfghiJIIzMmCD3Ez",
"businessUnitId": "abCdEfghiJIIzMmCD3Ez"
}
]
}
}

Get Profiles

Retrieves the assessment profiles for a business unit

Authorizations:

Bearer

path Parameters

businessUnitId required	string The ID of the business unit
assessmentId required	string The ID of the assessment

Responses

Response samples

200

Content type

application/json

{"message": "string",
"response": {"profiles": [{"profileId": "string",
"subcategories": ["string"
]
}
],
"assessmentTypeId": "string",
"businessUnitId": "string",
"assessmentId": "string"
}
}

Get Scores

Retrieves the results for an assessment

Authorizations:

Bearer

path Parameters

businessUnitId required	string The ID of the business unit
assessmentId required	string The ID of the assessment

query Parameters

profileId

string

The ID of the profile to retrieve scores for

Responses

Response samples

200

Content type

application/json

{"message": "string",
"response": {"businessUnitId": "string",
"assessmentId": "string",
"assessmentTypeId": "string",
"scoreLabels": [{"subId": "string",
"abbr": "string",
"name": "string"
}
],
"targetLabels": [{"subId": "string",
"abbr": "string",
"name": "string"
}
],
"profileId": "string",
"scores": [{"itemId": "string",
"aspectPercentDone": 0,
"aspectTotalAnswerCount": 0,
"aspectTotalCount": 0,
"percentDone": 0,
"percentOfTarget": 0,
"questionCount": 0,
"score": 0,
"subs": [{"subId": "string",
"answerCount": 0,
"percentDone": 0,
"percentOfTarget": 0,
"questionCount": 0,
"score": 0,
"target": 0,
"weight": 0,
"weightLabel": "string"
}
],
"target": 0,
"weight": 0,
"weightLabel": "string"
}
],
"ignoredQuestions": ["string"
]
}
}

Get User

Retrieves the details of a user

Authorizations:

Bearer

path Parameters

userId

required

string

The ID of the user

Responses

Response samples

200

Content type

application/json

{"message": "string",
"response": {"displayName": "string",
"email": "string",
"userId": "string"
}
}

Get Assessment Content

Retrieves the content for an assessment

Authorizations:

Bearer

path Parameters

businessUnitId required	string The ID of the business unit
assessmentId required	string The ID of the assessment

Responses

Response samples

200

Content type

application/json

{"message": "string",
"response": {"businessUnitId": "string",
"assessmentId": "string",
"assessmentTypeId": "string",
"content": null
}
}

Get Scenario Families

gets all the scenario families in a business unit

Authorizations:

Bearer

path Parameters

businessUnitId

required

string

The ID of the business unit

Responses

Response samples

200

Content type

application/json

{"message": "string",
"response": {"scenarioFamilies": [{"scenarioFamilyName": "Default 01 - Fraud and Ransomware",
"scenarioFamilyId": "584YU95ux8vuKhALajNh"
}
]
}
}

Get Scenario Family

gets a specific scenario family

Authorizations:

Bearer

path Parameters

businessUnitId required	string The ID of the business unit
scenarioFamilyId required	string Unique identifier for the scenario family.

Responses

Response samples

200

Content type

application/json

{"message": "string",
"response": {"scenarioFamilyName": "Default 01 - Fraud and Ransomware",
"scenarioFamilyId": "584YU95ux8vuKhALajNh",
"description": "Cybercriminal organizations and independent actors targeting organizations rich in financial data for monetary gain",
"assessmentId": "yJh6dtjIiyGuTf36qV8R",
"scopeCategories": [{"name": "Threat Frequency",
"scopeItems": [{"lexicon": "threat-community",
"values": ["Organized Crime Groups: _All",
"Independent Cybercriminals: _All"
]
}
],
"narrativeJustification": "ransomware is a particularly dangerous threat for our company because of the sensitive data we handle",
"keyConsiderations": "this is a higher priority threat vector for our company"
}
],
"notes": [{"lexiconPath": "threat-community|Script Kiddies",
"note": "competing community"
}
]
}
}

Get Scenarios

gets all the scenarios in a scenario family

Authorizations:

Bearer

path Parameters

businessUnitId required	string The ID of the business unit
scenarioFamilyId required	string Unique identifier for the scenario family.

Responses

Response samples

200

Content type

application/json

{"message": "string",
"response": {"scenarios": [{"scenarioName": "Insider Threats",
"scenarioId": "NanXEvGH3D35zR8F8j4h"
}
]
}
}

Get Scenario

gets a specific scenario

Authorizations:

Bearer

path Parameters

businessUnitId required	string The ID of the business unit
scenarioFamilyId required	string Unique identifier for the scenario family.
scenarioId required	string Unique identifier for the scenario.

Responses

Response samples

200

Content type

application/json

{"message": "string",
"response": {"lastRun": {"simulationResults": {"minALE": 0.1,
"aveALE": 0.1,
"maxALE": 0.1,
"modeALE": 0.1,
"percentiles": [{"percentile": 0.01,
"loss": 5.853759876731206e+44
}
]
},
"runSimulationParameters": {"scenarioName": "string",
"businessUnitId": "string",
"sampleCount": 0,
"factors": [{"index": 0,
"lambda": 0,
"mu": 0,
"name": "string",
"probabilityDistribution": "string",
"shortName": "string",
"sigma": 0,
"units": "string",
"description": "string",
"min": 0,
"max": 0,
"mode": 0,
"comment": "string",
"lossMagnitudeOption": "string",
"enabled": true,
"suggestedValuePresets": {"actorType": "External - Hacktivist",
"frequencyPreset": "Attack Vector: Malware"
}
}
]
},
"factorStatistics": [{"factorName": "string",
"minALE": 0.1,
"aveALE": 0.1,
"maxALE": 0.1,
"modeALE": 0.1,
"percentiles": [{"percentile": 0.01,
"loss": 5.853759876731206e+44
}
]
}
],
"lastRunTime": "2019-08-24T14:15:22Z",
"userId": "66c55a49-1d1d-494e-8c39-12b70fceb1dd"
},
"lastSavedAt": "2019-08-24T14:15:22Z",
"lastModifiedUserId": "66c55a49-1d1d-494e-8c39-12b70fceb1dd",
"scopeData": {"scopeCategories": [{"name": "Threat Frequency",
"scopeItems": [{"lexicon": "threat-community",
"values": ["Organized Crime Groups: _All",
"Independent Cybercriminals: _All"
]
}
],
"narrativeJustification": "ransomware is a particularly dangerous threat for our company because of the sensitive data we handle",
"keyConsiderations": "this is a higher priority threat vector for our company"
}
],
"notes": [{"lexiconPath": "threat-community|Script Kiddies",
"note": "competing community"
}
],
"scenarioFamilyId": "584YU95ux8vuKhALajNh",
"effect": "The effect of the scenario on the business unit",
"threat": "The threat of the scenario on the business unit",
"asset": "The asset of the scenario on the business unit",
"scenarioPurpose": "The purpose of the scenario on the business unit",
"scenarioNarrativeAndDetail": "The narrative and detail of the scenario on the business unit"
},
"id": "string",
"scenarioName": "string",
"factors": [{"index": 0,
"lambda": 0,
"mu": 0,
"name": "string",
"probabilityDistribution": "string",
"shortName": "string",
"sigma": 0,
"units": "string",
"description": "string",
"min": 0,
"max": 0,
"mode": 0,
"comment": "string",
"lossMagnitudeOption": "string",
"enabled": true,
"suggestedValuePresets": {"actorType": "External - Hacktivist",
"frequencyPreset": "Attack Vector: Malware"
}
}
]
}
}

Ostrich Birdseye API (1.0.0)

Get Auth Token

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Business Units

Authorizations:

Responses

Response samples

Get Business Unit

Authorizations:

path Parameters

Responses

Response samples

Get Assessments

Authorizations:

path Parameters

Responses

Response samples

Get Assessment

Authorizations:

path Parameters

Responses

Response samples

Get Profiles

Authorizations:

path Parameters

Responses

Response samples

Get Scores

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Get User

Authorizations:

path Parameters

Responses

Response samples

Get Assessment Content

Authorizations:

path Parameters

Responses

Response samples

Get Scenario Families

Authorizations:

path Parameters

Responses

Response samples

Get Scenario Family

Authorizations:

path Parameters

Responses

Response samples

Get Scenarios

Authorizations:

path Parameters

Responses

Response samples

Get Scenario

Authorizations:

path Parameters

Responses

Response samples

Request Body schema: application/json
required