Skip to content
Adversarial
Search
Ctrl
K
Cancel
Website
Login
Select theme
Dark
Light
Auto
Getting Started
Introduction
Authentication
Tutorials
Tutorials
Complete a Risk Lifecycle
Set Up Your Adversarial Tenant
Guides
Risks
Risk Register
Creating Risks
Risk Fields
Scoring and Remediation
FAQ
Incidents
Incident Register
Creating Incidents
Incident Fields
Scoring and Response
FAQ
Threats
Configuring Your Threat Profile
Threat Profile
Compliance
Compliance
CyberGov
Integrations
Integrations
CrowdStrike
GreyMatter
Wiz
HackerOne
BugCrowd
WatchTowr
Jira
Concepts
Platform Overview
AI Features
Threat Objectives
API Reference
Overview
Authorization
Handler to receive the OAuth2 callback from a provider This will validate the CSRF token set when we redirected to the provider, and then retrieve the user's profile information
Handler for recieving a request to perform an OAuth2 login with the given provider This will create a new session, store the CSRF token, and redirect to the Google login page
Handler to logout the user by destroying the session
Handler to switch the user's organization context to another they are a member of
Comments
Update a comment by ID
Delete a comment by ID
Context
Retrieve information about the current user and their organization
Documents
List documents
Download the Board Deck powerpoint
Download the cybergov powerpoint
Make changes to documents
Approve or deny an open proposal
Get editor data for a document
Get a document
Filter Views
List filter views for the current user
Create a new filter view
Get a filter view by ID
Update a filter view
Delete a filter view
Incidents
List incidents with associated components for the incident register
Create a new incident
Delete many incidents by incident IDs
Update many incident's editable fields, given a list of incident IDs
Count incidents
export_incidents_csv
Suggest scores for many incidents based on the provided parameters
List all incident sources available for use in the organization
Add a new incident source to be available for use in the organization
Delete an incident source from the organization
Set incident sources back to the defaults
Get an incident by ID
Update some of an incident's editable fields, by ID
Get comments for an incident
Create a new comment for an incident
Create a new risk from an incident
Associate a risk with an incident
Remove a risk association from an incident
Suggest an incident score based on the provided parameters
Remove a tag from an incident
Get threats associated with an incident
Add a tag to an incident
Integrations
get_configured_integrations
preview_import_jira_incidents
import_jira_incidents
preview_issues
preview_jira_import_risks
import_jira_risks
get_linked_issues_for_risk
create_issue_for_risk
link_risk_to_issue
get_slack_config
upsert_slack_config
delete_slack_config
list_slack_channels
add_slack_subscription
remove_slack_subscription
test_slack_connection
get_teams_config
upsert_teams_config
delete_teams_config
list_teams_channels
add_teams_subscription
remove_teams_subscription
test_teams_connection
get_integration_config
upsert_integration_config
delete_integration_config
Generic preview handler for incident integrations
Generic import handler for incident integrations
preview_integration_risks
import integration_risks
integrations::jira
unlink_risk_from_issue
Notifications
list notifications for user
Mark all notifications as read for the current user
mark notification as read
Notification Preferences
Get all notification preferences with explicit boolean states Returns preferences grouped by category, with all channels showing enabled/disabled state
Add a channel preference for a notification type
Remove a specific channel preference
Subscriptions
List individual item subscriptions for user
Add subscriptions for user (individual notification types only) Note: This endpoint only handles individual notification types (those requiring an item_identifier). For general notification types, use the preferences endpoints which auto-manage subscriptions.
Remove subscription for user (individual notification types only) Note: This endpoint only handles individual notification types (those requiring an item_identifier). For general notification types, use the preferences endpoints which auto-manage subscriptions.
Organizations
Retrieve the organizations the user is a member of
List the domains associated with the users organization
Add a domain to the users organization
Delete a domain from the users organization
list the outstanding invitations for the current organization
Create an invitation to join the organization
Delete an invitation to join the organization
Get an overview of the users organization portfolio
Retrieve the requested organization
Leave the provided organization
Update attributes of the users organization
Get compliance metrics for an organization (critical/high AKR closure rate)
get_risk_performance_metrics
Add a tag to an organization
Remove a tag from an organization, this is distinct from removing one of the organizations owned tags
Risks
Create a new risk
Update many risks
List all risks of type "AKR"
Count risks
export_risks_csv
Get remediation agility for an organization
Get remediation agility for an organization
List all risks of type "RSK"
Delete many RSK risks by risk IDs
Suggest a risk score based on the provided parameters
Suggest a risk score based on the provided parameters
Get the SLAs for the current organization
Reset the SLAs for the current organization
Update the SLAs for the current organization
List all Risk sources available for use in the organization
Add a new Risk source to be available for use in the organization
Delete a risk source from the organization
Reset the risk sources to the default values
List all Risk types available for use in the organization
get a risk by a risk ID
Update parts of a risk by a risk ID
List comments for a risk
Create a new comment for a risk
Associate an incident with a risk
Remove an incident association from a risk
Get all tags associated with a risk
Add a tag to a risk
Remove a tag from a risk
Users
List all service accounts (integration users) in the organization
List all users in the user's organization
Retrieve information about the current user and their organization
Update the current user's profile details
Accept an invitation to join an organization
accept_invite
Decline an invitation to join another organization
Get a user by ID in the user's organization
Tags
Create a new tag
List item tags for the organization
List tags created by the user
get_tag
delete_tag
update_tag
Get statistics for a specific tag
Threats
List all threat objective data for an organization. Drafts on a threat's inherent score are excluded from the results.
List all threat objective data for a specific organization by UUID. The user must be a member of the organization to access this data. Drafts on a threat's inherent score are excluded from the results.
Get a preview of key risk and policy suggestion changes based on threat level changes
List all proposals to change threats made for the organization
Create a new proposal to change a threat profile
Get the currently active proposal
Update a pending proposal by modifying its threat positions and/or approving or denying it
Get threat objective data by slug
Website
Login
Select theme
Dark
Light
Auto
Handler to logout the user by destroying the session
POST
/v1/auth/logout
Production
Staging
Local
Responses
Section titled “ Responses ”
200
Section titled “200 ”
OK
500
Section titled “500 ”
Internal server error
