Tenchi logo
API docs by Redocly

Zanshin API (0.0.0)

Download OpenAPI specification:

Tenchi Security: contact@tenchisecurity.com Terms of Service

This is the documentation for the Zanshin Product API. Zanshin is a vulnerability management platform that manages cloud risks on service providers for your company. Learn more at https://www.tenchisecurity.com/.

Note: This documentation file covers the current endpoint only.

Find out more about Zanshin or Tenchi

System overview

Zanshin is a platform where organizations are registered and then can register their cloud environments into the system for regular security checks. Organizations can register scan Targets, as the name implies, those are the target cloud accounts that will be scanned and monitored for potential security breachs.

Once one or more scan targets are registered the system will periodically run scans, those scans will generate security alerts that can be viewed and will provide details about the detected breach, why it is a breach, which renowed guidelines does it violate, the best practice for a fix, the affected resources and other usefull data. The scan history will also be preserved so the organization can keep track of the over time improvements.

Beyond scanning their own cloud infrastructures Zanshin provides organizations with the ability to follow and be followed by other organizations, in a social-network-like environment. When a organization follows another it can see the alerts and potential secutrity issues of the followed organization. This creates a situation where an organization that has several service provider can follow all of them and be assured that they are all following the best cyber security practices. The organizations that are being followed can allow clients and potential hirers to follow them and show off their awesome security skills to their employers.

Main concepts

  • User: an user account inside the system. One login. A user must be a member of one or more organizations. Users cannot follow or be followed, they inherit the follows as followings permissions of their organizations.

  • Member a user inside of an organization is a member of that organization. They can be admins with the powers to create and configure scan targets, accept risks, etc. or regular members with read-only permissions.

  • Organization the enitity representing a company, businness, or sector of a company it has members, it has scan targets and it can follow and be followed by other organizations. Some companies make different organizations for each of their internal divisions and follow each other.

  • Followers the organizations that follow your organization. Akin to social networks followers can see the situation of your scan targets and track your alerts. Some sensitive data relating to the alerts may be censored to the followers.

  • Following the organizations that your organization is currently following. You will be able to see their satus on each of the scan targets and keep track of any security issues they have.

  • Scan target a single cloud account (be it GCP, AWS, Azure, etc) it is a target of the scans. Where the security checks will happen. One organization may have as many scan targets as they wish.

  • Scan the results of a security check of a given scan target, it will happen periodically and automatically but can also be triggered manually.

  • Alert a scan will generate several alerts for each scan target (or none if your security is pristine). Alerts are just that, alerts of potential security failures or guidelines not being followed. Alerts have all the info you need on the problem severity and how to handle it. They can be viewed by the followers. ALerts cannot be manually closed, they are only considered closed when the next scan detects that the problem has been solved.

Programmatically Accessing endpoints

To use the documented endpoints of this documentation login into zanshin and Generate API Keys from the menu. Use the newly generate key as the {AUTH_TOKEN} mentioned through the docs.

Account

Accepts an invite

Accepts an invitation and returns the created membership for that invitation

Authorizations:
ZanshinAuth
path Parameters
token
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.zanshin.tenchisecurity.com/me/invites/{token}/accept \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "name": "string",
  • "email": "string",
  • "roles": [
    ],
  • "identityProvider": "string",
  • "lastIp": "string",
  • "lastLogin": "string",
  • "loginsCount": 0,
  • "picture": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create API Key

Creates a new API key for the current logged user.

Authorizations:
ZanshinAuth
Request Body schema: text/plain
required
string

Responses

Request samples 

curl --request POST \
  --url https://api.zanshin.tenchisecurity.com/me/apikeys \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "12349876-bbbb-aaaa-8888-222220000fff",
  • "name": "Jomae-ya",
  • "key": "***123-Aa",
  • "userId": "f12345ab-6cd9-ab88-999e-bbdd2266f1b2",
  • "lastIp": "192.168.0.1",
  • "lastUse": "2025-04-07T19:03:28.014Z",
  • "createdAt": "2025-03-22T09:54:56.123Z"
}

Delete API Key by ID

Deletes a given api key by its ID, only work if the key belongs to the current logged user

Authorizations:
ZanshinAuth
path Parameters
apiKeyId
required
string <uuid> (common.Id)

Responses

Request samples 

curl --request DELETE \
  --url https://api.zanshin.tenchisecurity.com/me/apikeys/{apiKeyId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Get current user data.

List all data related to the current logger user.

Authorizations:
ZanshinAuth

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/me \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "f12345ab-6cd9-ab88-999e-bbdd2266f1b2",
  • "name": "Miyamoto Musashi",
  • "email": "niten_doraku@edo.com",
  • "roles": [ ],
  • "status": "ACTIVE",
  • "member": [
    ],
  • "following": [
    ],
  • "picture": "https://s.gravatar.com/avatar/a",
  • "language": "pr-BR",
  • "identityProvider": "google-oauth2",
  • "emailVerified": true,
  • "lastIp": "192.168.0.1",
  • "loginsCount": 42,
  • "lastLogin": "2025-04-18T18:14:32.123Z",
  • "createdAt": "2023-01-13T12:34:56.123Z",
  • "updatedAt": "2025-02-21T15:44:12.123Z"
}

Get current user invites

Get all pending invites for the current user.

Authorizations:
ZanshinAuth

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/me/invites \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • {
    }
]

Get invite details by token

Get details for a specific invite

Authorizations:
ZanshinAuth
path Parameters
token
required
string

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/me/invites/{token} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "organizationName": "string",
  • "email": "string",
  • "roles": [
    ],
  • "expiredAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z"
}

List user active api keys

Lists all active API Keys for an user, API Keys can be used to interact directly with the zanshin API on the behalf of that user.

Authorizations:
ZanshinAuth

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/me/apikeys \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • {
    }
]

Update Account Information

Update account information for current user.

Authorizations:
ZanshinAuth
Request Body schema: application/json
required
name
string
picture
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "picture": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "email": "string",
  • "roles": [
    ],
  • "picture": "string",
  • "language": "string"
}

Alert

Batch update alerts

Batch Update Alerts

Updates the status of multiple alerts in a single operation. Allows bulk operations like marking alerts as resolved, reopening, or adding comments to multiple alerts based on specified criteria.

Permission required: organizationAlerts: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Batch update criteria and new status information

comment
string
required
object
dryRun
required
boolean

If true the command will not actually update the alerts, but will return the count of alerts that would have been updated.

includeEmptyScanTargetTags
boolean
scanTargetIds
Array of strings <uuid> (scantarget.ScanTargetId) [ items <uuid > ]
scanTargetTags
Array of strings (scantarget.ScanTargetTag)
required
object
alertIds
Array of strings <uuid> (alert.AlertId) [ items <uuid > ]
rules
Array of strings (alert.AlertRule)
severities
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
states
Array of strings (alert.AlertState)
Items Enum: "OPEN" "IN_PROGRESS" "RISK_ACCEPTED" "MITIGATING_CONTROL" "FALSE_POSITIVE" "CLOSED"
state
required
Array of strings (alert.AlertState)
Items Enum: "OPEN" "IN_PROGRESS" "RISK_ACCEPTED" "MITIGATING_CONTROL" "FALSE_POSITIVE" "CLOSED"

Responses

Request samples

Content type
application/json
{
  • "state": [
    ],
  • "comment": "string",
  • "condition": {
    }
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "dryRun": true
}

Create alert comment

Create Alert Comment

Adds a new comment to a specific alert. Comments are used for collaboration, providing context about investigation findings, remediation steps, or additional information about the security issue.

Permission required: organizationAlerts: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
alertId
required
string <uuid> (alert.AlertId)

Alert unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Comment content and metadata

comment
required
string
mimeType
string

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "mimeType": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "comment": "string",
  • "mimeType": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Get alert

Get Alert

Retrieves detailed information about a specific security alert, including its current state, severity, affected resources, and remediation details.

Permission required: organizationAlerts: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
alertId
required
string <uuid> (alert.AlertId)

Alert unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/alerts/{alertId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "scanTargetId": "32633caa-78f8-40bd-b819-2deeb6a14790",
  • "rule": "string",
  • "resource": "string",
  • "severity": "CRITICAL",
  • "state": "OPEN",
  • "version": 0,
  • "tags": [
    ],
  • "labels": [
    ],
  • "compliances": [
    ],
  • "enrichment": { },
  • "metadata": { },
  • "openedAt": "2019-08-24T14:15:22Z",
  • "resolvedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "ruleTitle": "string",
  • "timelinessThreshold": 0.1
}

Get alert history

Get Alert History

Retrieves the complete history of changes for a specific alert, including state transitions, status updates, comments, and modifications. Essential for incident response tracking and forensic analysis.

Permission required: organizationAlerts: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
alertId
required
string <uuid> (alert.AlertId)

Alert unique identifier

query Parameters
cursor
string
size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/alerts/{alertId}/history?size={INTEGER}&cursor={STRING}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

List alert comments

List Alert Comments

Retrieves all comments associated with a specific alert. Comments provide collaboration context, investigation notes, and remediation documentation for security incident management.

Permission required: organizationAlerts: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
alertId
required
string <uuid> (alert.AlertId)

Alert unique identifier

query Parameters
page
integer <uint16> >= 1
Default: 1
size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/alerts/{alertId}/comments?size={INTEGER}&page={INTEGER}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List alert history

List Alert History

Retrieves historical records of alert state changes, status updates, and modifications. Provides an audit trail for security incident management and compliance reporting.

Permission required: organizationAlerts: READ_ONLY

Authorizations:
ZanshinAuth
query Parameters
cursor
string
size
integer <uint16> [ 1 .. 1000 ]
Default: 25
Request Body schema: application/json
required

Alert history filtering criteria including organization and date ranges

cursor
string
lang
string (common.Language)
Enum: "pt-BR" "en-US"
organizationId
required
string <uuid> (organization.OrganizationId)
pageSize
required
integer
scanTargetIds
Array of strings <uuid> (scantarget.ScanTargetId) [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "scanTargetIds": [
    ],
  • "lang": "pt-BR",
  • "pageSize": 0,
  • "cursor": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

List alerts

List Alerts

Retrieves a filtered and paginated list of security alerts for the specified organization. Supports various filtering options including severity, state, scan target types, date ranges, and custom search criteria.

Permission required: organizationAlerts: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
cursor
string
size
integer <uint16> [ 1 .. 1000 ]
Default: 25
Request Body schema: application/json
required

Alert filtering criteria

createdAtEnd
string <date-time> (common.UTCDateTime)
createdAtStart
string <date-time> (common.UTCDateTime)
includeEmptyScanTargetTags
boolean (common.IncludeEmptyScanTargetTags)

(Optional) Return objects without any ScanTarget tags.

lang
string (common.Language)
Enum: "pt-BR" "en-US"
openedAtEnd
string <date-time> (common.UTCDateTime)
openedAtStart
string <date-time> (common.UTCDateTime)
order
string
Enum: "resource" "rule" "severity" "state" "openedAt" "resolvedAt" "createdAt" "updatedAt" "scanTargetId"
resolvedAtEnd
string <date-time> (common.UTCDateTime)
resolvedAtStart
string <date-time> (common.UTCDateTime)
rules
Array of strings
scanTargetIds
Array of strings <uuid> (scantarget.ScanTargetId) [ items <uuid > ]
scanTargetKinds
Array of strings (scantarget.ScanTargetKind)
Items Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"
scanTargetTags
Array of strings (scantarget.ScanTargetTag)
search
string
severities
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
sort
string (common.Sort)
Enum: "DESC" "ASC"
states
Array of strings (alert.AlertState)
Items Enum: "OPEN" "IN_PROGRESS" "RISK_ACCEPTED" "MITIGATING_CONTROL" "FALSE_POSITIVE" "CLOSED"
updatedAtEnd
string <date-time> (common.UTCDateTime)
updatedAtStart
string <date-time> (common.UTCDateTime)

Responses

Request samples

Content type
application/json
{
  • "rules": [
    ],
  • "states": [
    ],
  • "severities": [
    ],
  • "scanTargetKinds": [
    ],
  • "search": "string",
  • "lang": "pt-BR",
  • "openedAtStart": "2019-08-24T14:15:22Z",
  • "openedAtEnd": "2019-08-24T14:15:22Z",
  • "resolvedAtStart": "2019-08-24T14:15:22Z",
  • "resolvedAtEnd": "2019-08-24T14:15:22Z",
  • "createdAtStart": "2019-08-24T14:15:22Z",
  • "createdAtEnd": "2019-08-24T14:15:22Z",
  • "updatedAtStart": "2019-08-24T14:15:22Z",
  • "updatedAtEnd": "2019-08-24T14:15:22Z",
  • "sort": "DESC",
  • "scanTargetIds": [
    ],
  • "scanTargetTags": [
    ],
  • "includeEmptyScanTargetTags": true,
  • "order": "resource"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

List alerts grouped by rules

List Alerts Grouped By Rules

Retrieves alerts organized by security rules, providing an aggregated view of how many alerts are triggered by each rule. Useful for identifying patterns and prioritizing security rule improvements.

Permission required: organizationAlerts: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
cursor
string
size
integer <uint16> [ 1 .. 1000 ]
Default: 25
Request Body schema: application/json
required

Alert grouping and filtering criteria

createdAtEnd
string <date-time> (common.UTCDateTime)
createdAtStart
string <date-time> (common.UTCDateTime)
includeEmptyScanTargetTags
boolean (common.IncludeEmptyScanTargetTags)

(Optional) Return objects without any ScanTarget tags.

lang
string (common.Language)
Enum: "pt-BR" "en-US"
openedAtEnd
string <date-time> (common.UTCDateTime)
openedAtStart
string <date-time> (common.UTCDateTime)
order
string
Enum: "rule" "severity" "total"
resolvedAtEnd
string <date-time> (common.UTCDateTime)
resolvedAtStart
string <date-time> (common.UTCDateTime)
rules
Array of strings
scanTargetIds
Array of strings <uuid> (scantarget.ScanTargetId) [ items <uuid > ]
scanTargetKinds
Array of strings (scantarget.ScanTargetKind)
Items Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"
scanTargetTags
Array of strings (scantarget.ScanTargetTag)
search
string
severities
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
sort
string (common.Sort)
Enum: "DESC" "ASC"
states
Array of strings (alert.AlertState)
Items Enum: "OPEN" "IN_PROGRESS" "RISK_ACCEPTED" "MITIGATING_CONTROL" "FALSE_POSITIVE" "CLOSED"
updatedAtEnd
string <date-time> (common.UTCDateTime)
updatedAtStart
string <date-time> (common.UTCDateTime)

Responses

Request samples

Content type
application/json
{
  • "rules": [
    ],
  • "states": [
    ],
  • "severities": [
    ],
  • "scanTargetKinds": [
    ],
  • "search": "string",
  • "lang": "pt-BR",
  • "openedAtStart": "2019-08-24T14:15:22Z",
  • "openedAtEnd": "2019-08-24T14:15:22Z",
  • "resolvedAtStart": "2019-08-24T14:15:22Z",
  • "resolvedAtEnd": "2019-08-24T14:15:22Z",
  • "createdAtStart": "2019-08-24T14:15:22Z",
  • "createdAtEnd": "2019-08-24T14:15:22Z",
  • "updatedAtStart": "2019-08-24T14:15:22Z",
  • "updatedAtEnd": "2019-08-24T14:15:22Z",
  • "sort": "DESC",
  • "scanTargetIds": [
    ],
  • "scanTargetTags": [
    ],
  • "includeEmptyScanTargetTags": true,
  • "order": "rule"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

List following alert history

List Following Alert History

Retrieves historical records of alert changes from followed organizations. Enables tracking of security incident resolution patterns across the extended organization network for collaborative security insights.

Permission required: organizationAlerts: READ_ONLY

Authorizations:
ZanshinAuth
query Parameters
cursor
string
size
integer <uint16> [ 1 .. 1000 ]
Default: 25
Request Body schema: application/json
required

Following alert history filtering criteria

cursor
string
followingIds
Array of strings <uuid> (scantarget.ScanTargetId) [ items <uuid > ]
lang
string (common.Language)
Enum: "pt-BR" "en-US"
organizationId
required
string <uuid> (organization.OrganizationId)
pageSize
required
integer

Responses

Request samples

Content type
application/json
{
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "followingIds": [
    ],
  • "lang": "pt-BR",
  • "pageSize": 0,
  • "cursor": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

List following alerts

List Following Alerts

Retrieves security alerts from organizations that this organization is following. This allows monitoring of security posture across partner organizations and supply chain entities, supporting collaborative security management.

Permission required: organizationAlerts: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
cursor
string
size
integer <uint16> [ 1 .. 1000 ]
Default: 25
Request Body schema: application/json
required

Following alert filtering criteria

createdAtEnd
string <date-time> (common.UTCDateTime)
createdAtStart
string <date-time> (common.UTCDateTime)
followingIds
Array of strings <uuid> (organization.OrganizationId) [ items <uuid > ]
followingTags
Array of strings (follow.FollowTag)
includeEmptyFollowingTags
boolean (common.IncludeEmptyFollowingTags)

(Optional) Return objects without any Following tags.

lang
string (common.Language)
Enum: "pt-BR" "en-US"
openedAtEnd
string <date-time> (common.UTCDateTime)
openedAtStart
string <date-time> (common.UTCDateTime)
order
string
Enum: "resource" "rule" "severity" "state" "openedAt" "resolvedAt" "createdAt" "updatedAt" "followingIds"
resolvedAtEnd
string <date-time> (common.UTCDateTime)
resolvedAtStart
string <date-time> (common.UTCDateTime)
rules
Array of strings
scanTargetKinds
Array of strings (scantarget.ScanTargetKind)
Items Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"
search
string
severities
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
sort
string (common.Sort)
Enum: "DESC" "ASC"
states
Array of strings (alert.AlertState)
Items Enum: "OPEN" "IN_PROGRESS" "RISK_ACCEPTED" "MITIGATING_CONTROL" "FALSE_POSITIVE" "CLOSED"
updatedAtEnd
string <date-time> (common.UTCDateTime)
updatedAtStart
string <date-time> (common.UTCDateTime)

Responses

Request samples

Content type
application/json
{
  • "rules": [
    ],
  • "states": [
    ],
  • "severities": [
    ],
  • "scanTargetKinds": [
    ],
  • "search": "string",
  • "lang": "pt-BR",
  • "openedAtStart": "2019-08-24T14:15:22Z",
  • "openedAtEnd": "2019-08-24T14:15:22Z",
  • "resolvedAtStart": "2019-08-24T14:15:22Z",
  • "resolvedAtEnd": "2019-08-24T14:15:22Z",
  • "createdAtStart": "2019-08-24T14:15:22Z",
  • "createdAtEnd": "2019-08-24T14:15:22Z",
  • "updatedAtStart": "2019-08-24T14:15:22Z",
  • "updatedAtEnd": "2019-08-24T14:15:22Z",
  • "sort": "DESC",
  • "followingIds": [
    ],
  • "followingTags": [
    ],
  • "includeEmptyFollowingTags": true,
  • "order": "resource"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

List following alerts grouped by rules

List Following Alerts Grouped By Rules

Retrieves alerts from followed organizations organized by security rules. Provides aggregated insights into security patterns and rule effectiveness across the extended organization network.

Permission required: organizationAlerts: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
cursor
string
size
integer <uint16> [ 1 .. 1000 ]
Default: 25
Request Body schema: application/json
required

Following alert grouping and filtering criteria

createdAtEnd
string <date-time> (common.UTCDateTime)
createdAtStart
string <date-time> (common.UTCDateTime)
followingIds
Array of strings <uuid> (organization.OrganizationId) [ items <uuid > ]
followingTags
Array of strings (follow.FollowTag)
includeEmptyFollowingTags
boolean (common.IncludeEmptyFollowingTags)

(Optional) Return objects without any Following tags.

lang
string (common.Language)
Enum: "pt-BR" "en-US"
openedAtEnd
string <date-time> (common.UTCDateTime)
openedAtStart
string <date-time> (common.UTCDateTime)
order
string
Enum: "rule" "severity" "total"
resolvedAtEnd
string <date-time> (common.UTCDateTime)
resolvedAtStart
string <date-time> (common.UTCDateTime)
rules
Array of strings
scanTargetKinds
Array of strings (scantarget.ScanTargetKind)
Items Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"
search
string
severities
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
sort
string (common.Sort)
Enum: "DESC" "ASC"
states
Array of strings (alert.AlertState)
Items Enum: "OPEN" "IN_PROGRESS" "RISK_ACCEPTED" "MITIGATING_CONTROL" "FALSE_POSITIVE" "CLOSED"
updatedAtEnd
string <date-time> (common.UTCDateTime)
updatedAtStart
string <date-time> (common.UTCDateTime)

Responses

Request samples

Content type
application/json
{
  • "rules": [
    ],
  • "states": [
    ],
  • "severities": [
    ],
  • "scanTargetKinds": [
    ],
  • "search": "string",
  • "lang": "pt-BR",
  • "openedAtStart": "2019-08-24T14:15:22Z",
  • "openedAtEnd": "2019-08-24T14:15:22Z",
  • "resolvedAtStart": "2019-08-24T14:15:22Z",
  • "resolvedAtEnd": "2019-08-24T14:15:22Z",
  • "createdAtStart": "2019-08-24T14:15:22Z",
  • "createdAtEnd": "2019-08-24T14:15:22Z",
  • "updatedAtStart": "2019-08-24T14:15:22Z",
  • "updatedAtEnd": "2019-08-24T14:15:22Z",
  • "sort": "DESC",
  • "followingIds": [
    ],
  • "followingTags": [
    ],
  • "includeEmptyFollowingTags": true,
  • "order": "rule"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Update alert

Update Alert

Updates the state, labels, or other properties of a specific security alert. Used for incident response workflows including marking alerts as resolved, adding investigation context, or updating alert metadata.

Permission required: organizationAlerts: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
alertId
required
string <uuid> (alert.AlertId)

Alert unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

scanTargetId
required
string <uuid> (scantarget.ScanTargetId)

Scan target unique identifier

Request Body schema: application/json
required

Updated alert properties

comment
string
labels
Array of strings (alert.AlertLabel)
state
string (alert.AlertState)
Enum: "OPEN" "IN_PROGRESS" "RISK_ACCEPTED" "MITIGATING_CONTROL" "FALSE_POSITIVE" "CLOSED"

Responses

Request samples

Content type
application/json
{
  • "state": "OPEN",
  • "labels": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "scanTargetId": "32633caa-78f8-40bd-b819-2deeb6a14790",
  • "rule": "string",
  • "resource": "string",
  • "severity": "CRITICAL",
  • "state": "OPEN",
  • "version": 0,
  • "tags": [
    ],
  • "labels": [
    ],
  • "compliances": [
    ],
  • "enrichment": { },
  • "metadata": { },
  • "openedAt": "2019-08-24T14:15:22Z",
  • "resolvedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "ruleTitle": "string",
  • "timelinessThreshold": 0.1
}

Attachment

Create attachment

Create a new attachment

Authorizations:
ZanshinAuth
Request Body schema: application/json
required

Attachment Data to create

contentLength
required
number
contentMD5
required
string
contentType
required
string
expiresAt
string <date-time> (common.UTCDateTime)
fileName
required
string

Responses

Request samples

Content type
application/json
{
  • "fileName": "string",
  • "contentLength": 0,
  • "contentType": "string",
  • "contentMD5": "string",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileName": "string",
  • "contentLength": 0,
  • "contentType": "string",
  • "contentMD5": "string",
  • "url": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Get attachment

Get attachment details

Authorizations:
ZanshinAuth
path Parameters
attachmentId
required
string <uuid> (attachment.AttachmentId)

Attachment unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/attachment/{attachmentId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileName": "string",
  • "contentLength": 0,
  • "contentType": "string",
  • "contentMD5": "string",
  • "url": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Document

Create Document

Create document to export alerts of organizations (CSV), following organizations (CSV), organization events (CSV), third party reports (PDF) and questionnaire reports (PDF).

Only members or followers can access.

This endpoint creates a pending request to generate an attachment with the export. When the export is ready, the status will change from PENDING to DONE and the field attachmentId will contain the id of the attachment that contains the download URL. The request GET /attachment/{attachmentId} returns details of the attachment.

To export alerts of organizations, the filter is the same used to list alerts in POST /organizations/{organizationId}/alerts.

To export alerts of following organizations, the filter is the same used to list following alerts in POST /organizations/{organizationId}/followings/alerts.

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)
Request Body schema: application/json
required
Any of
required
object (document.QuestionnaireReportParams)
required
object (document.QuestionnaireReportFilter)
assessmentId
required
string <uuid> (common.Id)
includeAnswers
required
boolean
language
required
string (common.Language)
Enum: "pt-BR" "en-US"
type
required
string
Value: "QUESTIONNAIRE_REPORT"

Responses

Request samples

Content type
application/json
Example
{
  • "type": "QUESTIONNAIRE_REPORT",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "status": "PENDING",
  • "type": "QUESTIONNAIRE_REPORT",
  • "params": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Delete document

Delete document

Authorizations:
ZanshinAuth
path Parameters
documentId
required
string <uuid> (document.DocumentId)

Document unique identifier

Responses

Request samples 

curl --request DELETE \
  --url https://api.zanshin.tenchisecurity.com/me/documents/{documentId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Download document

Download document

Authorizations:
ZanshinAuth
path Parameters
documentId
required
string <uuid> (document.DocumentId)

Document unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/me/documents/{documentId}/download \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
null

Get document by ID

Get document by ID

Authorizations:
ZanshinAuth
path Parameters
documentId
required
string <uuid> (document.DocumentId)

Document unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/me/documents/{documentId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "status": "PENDING",
  • "type": "QUESTIONNAIRE_REPORT",
  • "params": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

List user documents

Get all documents for the current user

Authorizations:
ZanshinAuth

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/me/documents \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • {
    }
]

Event

Get event names

Get all event names divided by entity Returns all available event names organized by entity type for filtering purposes

Authorizations:
ZanshinAuth

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/events/names \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "alert": [
    ],
  • "alertComment": [
    ],
  • "answer": [
    ],
  • "assessment": [
    ],
  • "assessmentComment": [
    ],
  • "follower": [
    ],
  • "following": [
    ],
  • "member": [
    ],
  • "organization": [
    ],
  • "question": [
    ],
  • "questionnaire": [
    ],
  • "scan": [
    ],
  • "scanTarget": [
    ],
  • "webhook": [
    ]
}

List Events of an organization

List the events of an organization with optional filtering by date range and event name

Permission required: organizationSettings: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization Id.

query Parameters
cursor
string
end
string <date-time> (common.UTCDateTime)

End date for filtering events.

name
string

Event name filter.

size
integer <uint16> [ 1 .. 1000 ]
Default: 25
start
string <date-time> (common.UTCDateTime)

Start date for filtering events.

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/events?start={STRING}&end={STRING}&name={STRING}&size={INTEGER}&cursor={STRING}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Events

AlertCommentCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (alert.AlertComment)
alertId
required
string <uuid> (alert.AlertId)
comment
required
string
createdAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (alert.CommentId)
mimeType
required
string
organizationId
required
string <uuid> (organization.OrganizationId)
userId
required
string <uuid> (user.UserId)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "AlertCommentCreated"
source
required
string
Value: "zanshin.alert.comment"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "AlertCommentCreated",
  • "source": "zanshin.alert.comment",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

AlertCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (alert.Alert)

The template for picking properties.

compliances
required
Array of strings (alert.AlertCompliance)
createdAt
required
string <date-time> (common.UTCDateTime)
required
alert.AlertEnrichment (object) or Array of alert.AlertEnrichment (objects)
Any of
property name*
additional property
any
id
required
string <uuid> (alert.AlertId)
labels
required
Array of strings (alert.AlertLabel)
required
object (alert.AlertMetadata)
property name*
additional property
string
openedAt
string <date-time> (common.UTCDateTime)
organizationId
required
string <uuid> (organization.OrganizationId)
resolvedAt
string <date-time> (common.UTCDateTime)
resource
required
string
rule
required
string (alert.AlertRule)
ruleTitle
string
scanTargetId
string <uuid> (scantarget.ScanTargetId)
severity
required
string (alert.AlertSeverity)
Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
state
required
string (alert.AlertState)
Enum: "OPEN" "IN_PROGRESS" "RISK_ACCEPTED" "MITIGATING_CONTROL" "FALSE_POSITIVE" "CLOSED"
tags
required
Array of strings (alert.AlertTag)
timelinessThreshold
number <float>
updatedAt
required
string <date-time> (common.UTCDateTime)
version
required
integer <uint32> (alert.AlertVersion)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "AlertCreated"
source
required
string
Value: "zanshin.alert"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "AlertCreated",
  • "source": "zanshin.alert",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

AlertFollowingCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (alert.Alert)

The template for picking properties.

compliances
required
Array of strings (alert.AlertCompliance)
createdAt
required
string <date-time> (common.UTCDateTime)
required
alert.AlertEnrichment (object) or Array of alert.AlertEnrichment (objects)
Any of
property name*
additional property
any
id
required
string <uuid> (alert.AlertId)
labels
required
Array of strings (alert.AlertLabel)
required
object (alert.AlertMetadata)
property name*
additional property
string
openedAt
string <date-time> (common.UTCDateTime)
organizationId
required
string <uuid> (organization.OrganizationId)
resolvedAt
string <date-time> (common.UTCDateTime)
resource
required
string
rule
required
string (alert.AlertRule)
ruleTitle
string
scanTargetId
string <uuid> (scantarget.ScanTargetId)
severity
required
string (alert.AlertSeverity)
Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
state
required
string (alert.AlertState)
Enum: "OPEN" "IN_PROGRESS" "RISK_ACCEPTED" "MITIGATING_CONTROL" "FALSE_POSITIVE" "CLOSED"
tags
required
Array of strings (alert.AlertTag)
timelinessThreshold
number <float>
updatedAt
required
string <date-time> (common.UTCDateTime)
version
required
integer <uint32> (alert.AlertVersion)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "AlertFollowingCreated"
source
required
string
Value: "zanshin.alert"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "AlertFollowingCreated",
  • "source": "zanshin.alert",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

AlertFollowingUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (alert.Alert)

The template for picking properties.

compliances
required
Array of strings (alert.AlertCompliance)
createdAt
required
string <date-time> (common.UTCDateTime)
required
alert.AlertEnrichment (object) or Array of alert.AlertEnrichment (objects)
Any of
property name*
additional property
any
id
required
string <uuid> (alert.AlertId)
labels
required
Array of strings (alert.AlertLabel)
required
object (alert.AlertMetadata)
property name*
additional property
string
openedAt
string <date-time> (common.UTCDateTime)
organizationId
required
string <uuid> (organization.OrganizationId)
resolvedAt
string <date-time> (common.UTCDateTime)
resource
required
string
rule
required
string (alert.AlertRule)
ruleTitle
string
scanTargetId
string <uuid> (scantarget.ScanTargetId)
severity
required
string (alert.AlertSeverity)
Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
state
required
string (alert.AlertState)
Enum: "OPEN" "IN_PROGRESS" "RISK_ACCEPTED" "MITIGATING_CONTROL" "FALSE_POSITIVE" "CLOSED"
tags
required
Array of strings (alert.AlertTag)
timelinessThreshold
number <float>
updatedAt
required
string <date-time> (common.UTCDateTime)
version
required
integer <uint32> (alert.AlertVersion)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "AlertFollowingUpdated"
source
required
string
Value: "zanshin.alert"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "AlertFollowingUpdated",
  • "source": "zanshin.alert",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

AlertUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (alert.Alert)

The template for picking properties.

compliances
required
Array of strings (alert.AlertCompliance)
createdAt
required
string <date-time> (common.UTCDateTime)
required
alert.AlertEnrichment (object) or Array of alert.AlertEnrichment (objects)
Any of
property name*
additional property
any
id
required
string <uuid> (alert.AlertId)
labels
required
Array of strings (alert.AlertLabel)
required
object (alert.AlertMetadata)
property name*
additional property
string
openedAt
string <date-time> (common.UTCDateTime)
organizationId
required
string <uuid> (organization.OrganizationId)
resolvedAt
string <date-time> (common.UTCDateTime)
resource
required
string
rule
required
string (alert.AlertRule)
ruleTitle
string
scanTargetId
string <uuid> (scantarget.ScanTargetId)
severity
required
string (alert.AlertSeverity)
Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
state
required
string (alert.AlertState)
Enum: "OPEN" "IN_PROGRESS" "RISK_ACCEPTED" "MITIGATING_CONTROL" "FALSE_POSITIVE" "CLOSED"
tags
required
Array of strings (alert.AlertTag)
timelinessThreshold
number <float>
updatedAt
required
string <date-time> (common.UTCDateTime)
version
required
integer <uint32> (alert.AlertVersion)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "AlertUpdated"
source
required
string
Value: "zanshin.alert"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "AlertUpdated",
  • "source": "zanshin.alert",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

AnswerCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Answer)
assessmentId
required
string <uuid> (questionnaire.AssessmentId)
required
Array of objects (questionnaire.AnswerContent)
Array
attachmentIds
required
Array of strings <uuid> (attachment.AttachmentId) [ items <uuid > ]
required
Array of objects (attachment.Attachment)
required
questionnaire.AnswerEmptyContent (object) or questionnaire.AnswerTextContent (object) or questionnaire.AnswerSingleChoiceContent (object) or questionnaire.AnswerMultipleChoiceContent (object) or questionnaire.AnswerFileContent (object)
createdAt
required
string <date-time> (common.UTCDateTime)
createdAt
required
string <date-time> (common.UTCDateTime)
questionId
required
string <uuid> (questionnaire.ElementId)
questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)
questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)
receiverId
required
string <uuid> (organization.OrganizationId)
senderId
required
string <uuid> (organization.OrganizationId)
status
required
string (questionnaire.AnswerStatus)
Enum: "NEW" "REQUESTED_REVIEW" "REQUESTED_CLARIFICATION" "APPROVED" "REJECTED" "SKIPPED"
updatedAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "AnswerCreated"
source
required
string
Value: "zanshin.questionnaire.answer"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "AnswerCreated",
  • "source": "zanshin.questionnaire.answer",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

AnswerUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Answer)
assessmentId
required
string <uuid> (questionnaire.AssessmentId)
required
Array of objects (questionnaire.AnswerContent)
Array
attachmentIds
required
Array of strings <uuid> (attachment.AttachmentId) [ items <uuid > ]
required
Array of objects (attachment.Attachment)
required
questionnaire.AnswerEmptyContent (object) or questionnaire.AnswerTextContent (object) or questionnaire.AnswerSingleChoiceContent (object) or questionnaire.AnswerMultipleChoiceContent (object) or questionnaire.AnswerFileContent (object)
createdAt
required
string <date-time> (common.UTCDateTime)
createdAt
required
string <date-time> (common.UTCDateTime)
questionId
required
string <uuid> (questionnaire.ElementId)
questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)
questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)
receiverId
required
string <uuid> (organization.OrganizationId)
senderId
required
string <uuid> (organization.OrganizationId)
status
required
string (questionnaire.AnswerStatus)
Enum: "NEW" "REQUESTED_REVIEW" "REQUESTED_CLARIFICATION" "APPROVED" "REJECTED" "SKIPPED"
updatedAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "AnswerUpdated"
source
required
string
Value: "zanshin.questionnaire.answer"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "AnswerUpdated",
  • "source": "zanshin.questionnaire.answer",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

AssessmentCommentEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.AssessmentComment)
assessmentId
required
string <uuid> (questionnaire.AssessmentId)
attachmentIds
required
Array of strings <uuid> (attachment.AttachmentId) [ items <uuid > ]
required
Array of objects (attachment.Attachment)
Array
contentLength
required
number
contentMD5
required
string
contentType
required
string
createdAt
required
string <date-time> (common.UTCDateTime)
expiresAt
string <date-time> (common.UTCDateTime)
fileName
required
string
id
required
string <uuid> (attachment.AttachmentId)
url
string (common.Url)
content
required
string (common.Markdown)
createdAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (questionnaire.AssessmentCommentId)
organizationId
required
string <uuid> (organization.OrganizationId)
required
questionnaire.ElementId (string) or null
Any of
string <uuid> (questionnaire.ElementId)
userId
required
string <uuid> (user.UserId)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "AssessmentCommentCreated"
source
required
string
Value: "zanshin.assessment.comment"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "AssessmentCommentCreated",
  • "source": "zanshin.assessment.comment",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

AssessmentCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Assessment)
required
Array of objects (questionnaire.AssessmentContactInformation)
Array
email
required
string (common.Email)
name
required
string
phone
string (common.PhoneNumber)
createdAt
required
string <date-time> (common.UTCDateTime)
description
required
string (questionnaire.AssessmentDescription)
dueDate
required
string <date-time> (common.UTCDateTime)
common.UTCDateTime (string) or null
Any of
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (questionnaire.AssessmentId)
name
required
string
questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)
questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)
receiverId
required
string <uuid> (organization.OrganizationId)
senderId
required
string <uuid> (organization.OrganizationId)
status
required
string (questionnaire.AssessmentStatus)
Enum: "NEW" "REQUESTED_REVIEW" "REQUESTED_CLARIFICATION" "APPROVED" "REJECTED"
updatedAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "AssessmentCreated"
source
required
string
Value: "zanshin.assessment"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "AssessmentCreated",
  • "source": "zanshin.assessment",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

AssessmentUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Assessment)
required
Array of objects (questionnaire.AssessmentContactInformation)
Array
email
required
string (common.Email)
name
required
string
phone
string (common.PhoneNumber)
createdAt
required
string <date-time> (common.UTCDateTime)
description
required
string (questionnaire.AssessmentDescription)
dueDate
required
string <date-time> (common.UTCDateTime)
common.UTCDateTime (string) or null
Any of
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (questionnaire.AssessmentId)
name
required
string
questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)
questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)
receiverId
required
string <uuid> (organization.OrganizationId)
senderId
required
string <uuid> (organization.OrganizationId)
status
required
string (questionnaire.AssessmentStatus)
Enum: "NEW" "REQUESTED_REVIEW" "REQUESTED_CLARIFICATION" "APPROVED" "REJECTED"
updatedAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "AssessmentUpdated"
source
required
string
Value: "zanshin.assessment"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "AssessmentUpdated",
  • "source": "zanshin.assessment",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

AttachmentCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (attachment.Attachment)

The template for picking properties.

contentLength
required
number
contentMD5
required
string
contentType
required
string
createdAt
required
string <date-time> (common.UTCDateTime)
expiresAt
string <date-time> (common.UTCDateTime)
fileName
required
string
id
required
string <uuid> (attachment.AttachmentId)
url
string (common.Url)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "AttachmentCreated"
source
required
string
Value: "zanshin.attachment"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "AttachmentCreated",
  • "source": "zanshin.attachment",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

AttachmentUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (attachment.Attachment)

The template for picking properties.

contentLength
required
number
contentMD5
required
string
contentType
required
string
createdAt
required
string <date-time> (common.UTCDateTime)
expiresAt
string <date-time> (common.UTCDateTime)
fileName
required
string
id
required
string <uuid> (attachment.AttachmentId)
url
string (common.Url)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "AttachmentUpdated"
source
required
string
Value: "zanshin.attachment"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "AttachmentUpdated",
  • "source": "zanshin.attachment",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

DocumentCreateEvent Webhook

Request Body schema: application/json
required
object (document.EventParams)
required
object (document.EventFilter)
end
string <date-time> (common.UTCDateTime)
name
string
start
string <date-time> (common.UTCDateTime)
type
required
string
Value: "EVENT"

Responses

Request samples

Content type
application/json
{
  • "type": "EVENT",
  • "params": {
    }
}

ElementCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Element)
attachmentIds
required
Array of strings <uuid> (attachment.AttachmentId) [ items <uuid > ]
required
Array of objects (attachment.Attachment)
Array
contentLength
required
number
contentMD5
required
string
contentType
required
string
createdAt
required
string <date-time> (common.UTCDateTime)
expiresAt
string <date-time> (common.UTCDateTime)
fileName
required
string
id
required
string <uuid> (attachment.AttachmentId)
url
string (common.Url)
createdAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (questionnaire.ElementId)
order
required
string (questionnaire.ElementOrder)
organizationId
required
string <uuid> (organization.OrganizationId)
required
object (questionnaire.QuestionProps)
description
required
string (questionnaire.QuestionDescription)
required
questionnaire.QuestionTextParams (object) or questionnaire.QuestionSingleChoiceParams (object) or questionnaire.QuestionMultipleChoiceParams (object) or questionnaire.QuestionFileParams (object)
title
required
string (questionnaire.QuestionTitle)
questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)
questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)
type
required
string (questionnaire.ElementType)
Value: "QUESTION"
updatedAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "ElementCreated"
source
required
string
Value: "zanshin.questionnaire.element"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "ElementCreated",
  • "source": "zanshin.questionnaire.element",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

ElementDeletedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Element)
attachmentIds
required
Array of strings <uuid> (attachment.AttachmentId) [ items <uuid > ]
required
Array of objects (attachment.Attachment)
Array
contentLength
required
number
contentMD5
required
string
contentType
required
string
createdAt
required
string <date-time> (common.UTCDateTime)
expiresAt
string <date-time> (common.UTCDateTime)
fileName
required
string
id
required
string <uuid> (attachment.AttachmentId)
url
string (common.Url)
createdAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (questionnaire.ElementId)
order
required
string (questionnaire.ElementOrder)
organizationId
required
string <uuid> (organization.OrganizationId)
required
object (questionnaire.QuestionProps)
description
required
string (questionnaire.QuestionDescription)
required
questionnaire.QuestionTextParams (object) or questionnaire.QuestionSingleChoiceParams (object) or questionnaire.QuestionMultipleChoiceParams (object) or questionnaire.QuestionFileParams (object)
title
required
string (questionnaire.QuestionTitle)
questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)
questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)
type
required
string (questionnaire.ElementType)
Value: "QUESTION"
updatedAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "ElementDeleted"
source
required
string
Value: "zanshin.questionnaire.element"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "ElementDeleted",
  • "source": "zanshin.questionnaire.element",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

ElementUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Element)
attachmentIds
required
Array of strings <uuid> (attachment.AttachmentId) [ items <uuid > ]
required
Array of objects (attachment.Attachment)
Array
contentLength
required
number
contentMD5
required
string
contentType
required
string
createdAt
required
string <date-time> (common.UTCDateTime)
expiresAt
string <date-time> (common.UTCDateTime)
fileName
required
string
id
required
string <uuid> (attachment.AttachmentId)
url
string (common.Url)
createdAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (questionnaire.ElementId)
order
required
string (questionnaire.ElementOrder)
organizationId
required
string <uuid> (organization.OrganizationId)
required
object (questionnaire.QuestionProps)
description
required
string (questionnaire.QuestionDescription)
required
questionnaire.QuestionTextParams (object) or questionnaire.QuestionSingleChoiceParams (object) or questionnaire.QuestionMultipleChoiceParams (object) or questionnaire.QuestionFileParams (object)
title
required
string (questionnaire.QuestionTitle)
questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)
questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)
type
required
string (questionnaire.ElementType)
Value: "QUESTION"
updatedAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "ElementUpdated"
source
required
string
Value: "zanshin.questionnaire.element"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "ElementUpdated",
  • "source": "zanshin.questionnaire.element",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

FollowerAcceptedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (follow.FollowRequest)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
followerId
required
string <uuid> (organization.OrganizationId)
followingId
required
string <uuid> (organization.OrganizationId)
required
object (share.ShareScanTargetTags)
mode
required
string
Value: "SCAN_TARGET_TAGS"
scanTargetTags
required
Array of strings (scantarget.ScanTargetTag)
followMode
required
string (follow.FollowMode)
Enum: "COOPERATIVE" "ANONYMOUS"
requestedBy
string (follow.FollowRequestBy)
Enum: "FOLLOWER" "FOLLOWING"
updatedAt
required
string <date-time> (common.UTCDateTime)
Array of objects (user.UserContact)
Array
email
required
string (common.Email)
name
required
string
phone
string
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "FollowerAccepted"
source
required
string
Value: "zanshin.follower"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "FollowerAccepted",
  • "source": "zanshin.follower",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

FollowerDeclinedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (follow.FollowRequest)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
followerId
required
string <uuid> (organization.OrganizationId)
followingId
required
string <uuid> (organization.OrganizationId)
required
object (share.ShareScanTargetTags)
mode
required
string
Value: "SCAN_TARGET_TAGS"
scanTargetTags
required
Array of strings (scantarget.ScanTargetTag)
followMode
required
string (follow.FollowMode)
Enum: "COOPERATIVE" "ANONYMOUS"
requestedBy
string (follow.FollowRequestBy)
Enum: "FOLLOWER" "FOLLOWING"
updatedAt
required
string <date-time> (common.UTCDateTime)
Array of objects (user.UserContact)
Array
email
required
string (common.Email)
name
required
string
phone
string
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "FollowerDeclined"
source
required
string
Value: "zanshin.follower"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "FollowerDeclined",
  • "source": "zanshin.follower",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

FollowerDeletedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (follow.Follower)
createdAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (organization.OrganizationId)
name
required
string
picture
string
score
integer <uint32>
required
object (share.ShareScanTargetTags)
mode
required
string
Value: "SCAN_TARGET_TAGS"
scanTargetTags
required
Array of strings (scantarget.ScanTargetTag)
status
required
string (organization.OrganizationStatus)
Enum: "ACTIVE" "SUSPENDED"

Get all the planet resources.

id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "FollowerDeleted"
source
required
string
Value: "zanshin.follower"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "FollowerDeleted",
  • "source": "zanshin.follower",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

FollowerRequestedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (follow.FollowRequest)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
followerId
required
string <uuid> (organization.OrganizationId)
followingId
required
string <uuid> (organization.OrganizationId)
required
object (share.ShareScanTargetTags)
mode
required
string
Value: "SCAN_TARGET_TAGS"
scanTargetTags
required
Array of strings (scantarget.ScanTargetTag)
followMode
required
string (follow.FollowMode)
Enum: "COOPERATIVE" "ANONYMOUS"
requestedBy
string (follow.FollowRequestBy)
Enum: "FOLLOWER" "FOLLOWING"
updatedAt
required
string <date-time> (common.UTCDateTime)
Array of objects (user.UserContact)
Array
email
required
string (common.Email)
name
required
string
phone
string
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "FollowerRequested"
source
required
string
Value: "zanshin.follower"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "FollowerRequested",
  • "source": "zanshin.follower",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

FollowerUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (follow.Follower)
createdAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (organization.OrganizationId)
name
required
string
picture
string
score
integer <uint32>
required
object (share.ShareScanTargetTags)
mode
required
string
Value: "SCAN_TARGET_TAGS"
scanTargetTags
required
Array of strings (scantarget.ScanTargetTag)
status
required
string (organization.OrganizationStatus)
Enum: "ACTIVE" "SUSPENDED"

Get all the planet resources.

id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "FollowerUpdated"
source
required
string
Value: "zanshin.follower"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "FollowerUpdated",
  • "source": "zanshin.follower",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

FollowingAcceptedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (follow.FollowRequest)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
followerId
required
string <uuid> (organization.OrganizationId)
followingId
required
string <uuid> (organization.OrganizationId)
required
object (share.ShareScanTargetTags)
mode
required
string
Value: "SCAN_TARGET_TAGS"
scanTargetTags
required
Array of strings (scantarget.ScanTargetTag)
followMode
required
string (follow.FollowMode)
Enum: "COOPERATIVE" "ANONYMOUS"
requestedBy
string (follow.FollowRequestBy)
Enum: "FOLLOWER" "FOLLOWING"
updatedAt
required
string <date-time> (common.UTCDateTime)
Array of objects (user.UserContact)
Array
email
required
string (common.Email)
name
required
string
phone
string
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "FollowingAccepted"
source
required
string
Value: "zanshin.following"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "FollowingAccepted",
  • "source": "zanshin.following",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

FollowingDeclinedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (follow.FollowRequest)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
followerId
required
string <uuid> (organization.OrganizationId)
followingId
required
string <uuid> (organization.OrganizationId)
required
object (share.ShareScanTargetTags)
mode
required
string
Value: "SCAN_TARGET_TAGS"
scanTargetTags
required
Array of strings (scantarget.ScanTargetTag)
followMode
required
string (follow.FollowMode)
Enum: "COOPERATIVE" "ANONYMOUS"
requestedBy
string (follow.FollowRequestBy)
Enum: "FOLLOWER" "FOLLOWING"
updatedAt
required
string <date-time> (common.UTCDateTime)
Array of objects (user.UserContact)
Array
email
required
string (common.Email)
name
required
string
phone
string
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "FollowingDeclined"
source
required
string
Value: "zanshin.following"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "FollowingDeclined",
  • "source": "zanshin.following",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

FollowingDeletedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (follow.Following)
createdAt
required
string <date-time> (common.UTCDateTime)
followerBusinessImpact
string (follow.BusinessImpact)
Enum: "SEVERE" "SIGNIFICANT" "MODERATE" "MINOR" "MINIMAL" "NOT_DEFINED"
followMode
string (follow.FollowMode)
Enum: "COOPERATIVE" "ANONYMOUS"
id
required
string <uuid> (organization.OrganizationId)
name
required
string
picture
string
requestedBy
string (follow.FollowRequestBy)
Enum: "FOLLOWER" "FOLLOWING"
score
integer <uint32>
status
required
string (organization.OrganizationStatus)
Enum: "ACTIVE" "SUSPENDED"

Get all the planet resources.

tags
Array of strings (follow.FollowTag)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "FollowingDeleted"
source
required
string
Value: "zanshin.following"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "FollowingDeleted",
  • "source": "zanshin.following",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

FollowingRequestedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (follow.FollowRequest)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
followerId
required
string <uuid> (organization.OrganizationId)
followingId
required
string <uuid> (organization.OrganizationId)
required
object (share.ShareScanTargetTags)
mode
required
string
Value: "SCAN_TARGET_TAGS"
scanTargetTags
required
Array of strings (scantarget.ScanTargetTag)
followMode
required
string (follow.FollowMode)
Enum: "COOPERATIVE" "ANONYMOUS"
requestedBy
string (follow.FollowRequestBy)
Enum: "FOLLOWER" "FOLLOWING"
updatedAt
required
string <date-time> (common.UTCDateTime)
Array of objects (user.UserContact)
Array
email
required
string (common.Email)
name
required
string
phone
string
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "FollowingRequested"
source
required
string
Value: "zanshin.following"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "FollowingRequested",
  • "source": "zanshin.following",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

FollowingUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (follow.Following)
createdAt
required
string <date-time> (common.UTCDateTime)
followerBusinessImpact
string (follow.BusinessImpact)
Enum: "SEVERE" "SIGNIFICANT" "MODERATE" "MINOR" "MINIMAL" "NOT_DEFINED"
followMode
string (follow.FollowMode)
Enum: "COOPERATIVE" "ANONYMOUS"
id
required
string <uuid> (organization.OrganizationId)
name
required
string
picture
string
requestedBy
string (follow.FollowRequestBy)
Enum: "FOLLOWER" "FOLLOWING"
score
integer <uint32>
status
required
string (organization.OrganizationStatus)
Enum: "ACTIVE" "SUSPENDED"

Get all the planet resources.

tags
Array of strings (follow.FollowTag)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "FollowingUpdated"
source
required
string
Value: "zanshin.following"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "FollowingUpdated",
  • "source": "zanshin.following",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

MemberCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (member.Member)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
email
required
string (common.Email)
identityProvider
string
lastIp
string
lastLogin
string
loginsCount
integer <uint64>
name
required
string
organizationId
required
string <uuid> (organization.OrganizationId)
picture
string
roles
required
Array of strings (member.MemberRole)
Items Value: "ADMIN"
updatedAt
required
string <date-time> (common.UTCDateTime)
userId
required
string <uuid> (user.UserId)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "MemberCreated"
source
required
string
Value: "zanshin.member"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "MemberCreated",
  • "source": "zanshin.member",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

MemberDeletedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (member.Member)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
email
required
string (common.Email)
identityProvider
string
lastIp
string
lastLogin
string
loginsCount
integer <uint64>
name
required
string
organizationId
required
string <uuid> (organization.OrganizationId)
picture
string
roles
required
Array of strings (member.MemberRole)
Items Value: "ADMIN"
updatedAt
required
string <date-time> (common.UTCDateTime)
userId
required
string <uuid> (user.UserId)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "MemberDeleted"
source
required
string
Value: "zanshin.member"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "MemberDeleted",
  • "source": "zanshin.member",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

MemberInviteAcceptedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (member.MemberInvite)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
email
required
string (common.Email)
expiredAt
required
string <date-time> (common.UTCDateTime)
organizationId
required
string <uuid> (organization.OrganizationId)
organizationName
string
roles
required
Array of strings (member.MemberRole)
Items Value: "ADMIN"
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "MemberInviteAccepted"
source
required
string
Value: "zanshin.member"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "MemberInviteAccepted",
  • "source": "zanshin.member",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

MemberInviteCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (member.MemberInvite)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
email
required
string (common.Email)
expiredAt
required
string <date-time> (common.UTCDateTime)
organizationId
required
string <uuid> (organization.OrganizationId)
organizationName
string
roles
required
Array of strings (member.MemberRole)
Items Value: "ADMIN"
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "MemberInviteCreated"
source
required
string
Value: "zanshin.member"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "MemberInviteCreated",
  • "source": "zanshin.member",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

MemberInviteDeletedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (member.MemberInvite)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
email
required
string (common.Email)
expiredAt
required
string <date-time> (common.UTCDateTime)
organizationId
required
string <uuid> (organization.OrganizationId)
organizationName
string
roles
required
Array of strings (member.MemberRole)
Items Value: "ADMIN"
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "MemberInviteDeleted"
source
required
string
Value: "zanshin.member"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "MemberInviteDeleted",
  • "source": "zanshin.member",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

MemberInviteResentEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (member.MemberInvite)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
email
required
string (common.Email)
expiredAt
required
string <date-time> (common.UTCDateTime)
organizationId
required
string <uuid> (organization.OrganizationId)
organizationName
string
roles
required
Array of strings (member.MemberRole)
Items Value: "ADMIN"
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "MemberInviteResent"
source
required
string
Value: "zanshin.member"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "MemberInviteResent",
  • "source": "zanshin.member",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

MemberMfaResetRequestedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (member.Member)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
email
required
string (common.Email)
identityProvider
string
lastIp
string
lastLogin
string
loginsCount
integer <uint64>
name
required
string
organizationId
required
string <uuid> (organization.OrganizationId)
picture
string
roles
required
Array of strings (member.MemberRole)
Items Value: "ADMIN"
updatedAt
required
string <date-time> (common.UTCDateTime)
userId
required
string <uuid> (user.UserId)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "MemberMfaResetRequested"
source
required
string
Value: "zanshin.member"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "MemberMfaResetRequested",
  • "source": "zanshin.member",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

MemberPasswordResetRequestedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (member.Member)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
email
required
string (common.Email)
identityProvider
string
lastIp
string
lastLogin
string
loginsCount
integer <uint64>
name
required
string
organizationId
required
string <uuid> (organization.OrganizationId)
picture
string
roles
required
Array of strings (member.MemberRole)
Items Value: "ADMIN"
updatedAt
required
string <date-time> (common.UTCDateTime)
userId
required
string <uuid> (user.UserId)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "MemberPasswordResetRequested"
source
required
string
Value: "zanshin.member"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "MemberPasswordResetRequested",
  • "source": "zanshin.member",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

MemberUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (member.Member)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
email
required
string (common.Email)
identityProvider
string
lastIp
string
lastLogin
string
loginsCount
integer <uint64>
name
required
string
organizationId
required
string <uuid> (organization.OrganizationId)
picture
string
roles
required
Array of strings (member.MemberRole)
Items Value: "ADMIN"
updatedAt
required
string <date-time> (common.UTCDateTime)
userId
required
string <uuid> (user.UserId)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "MemberUpdated"
source
required
string
Value: "zanshin.member"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "MemberUpdated",
  • "source": "zanshin.member",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

OrganizationCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (organization.Organization)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
email
string (common.Email)
features
Array of strings
id
required
string <uuid> (organization.OrganizationId)
name
required
string
picture
string (common.Url)
score
required
integer <uint32>

[DEPRECATED] Organization score based on all scan targets (overall score)

status
required
string (organization.OrganizationStatus)
Enum: "ACTIVE" "SUSPENDED"

Get all the planet resources.

updatedAt
required
string <date-time>

Date when this user was last updated

id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "OrganizationCreated"
source
required
string
Value: "zanshin.organization"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "OrganizationCreated",
  • "source": "zanshin.organization",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

OrganizationDeletedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (organization.Organization)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
email
string (common.Email)
features
Array of strings
id
required
string <uuid> (organization.OrganizationId)
name
required
string
picture
string (common.Url)
score
required
integer <uint32>

[DEPRECATED] Organization score based on all scan targets (overall score)

status
required
string (organization.OrganizationStatus)
Enum: "ACTIVE" "SUSPENDED"

Get all the planet resources.

updatedAt
required
string <date-time>

Date when this user was last updated

id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "OrganizationDeleted"
source
required
string
Value: "zanshin.organization"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "OrganizationDeleted",
  • "source": "zanshin.organization",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

OrganizationUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (organization.Organization)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
email
string (common.Email)
features
Array of strings
id
required
string <uuid> (organization.OrganizationId)
name
required
string
picture
string (common.Url)
score
required
integer <uint32>

[DEPRECATED] Organization score based on all scan targets (overall score)

status
required
string (organization.OrganizationStatus)
Enum: "ACTIVE" "SUSPENDED"

Get all the planet resources.

updatedAt
required
string <date-time>

Date when this user was last updated

id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "OrganizationUpdated"
source
required
string
Value: "zanshin.organization"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "OrganizationUpdated",
  • "source": "zanshin.organization",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

QuestionCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Question)
attachmentIds
required
Array of strings <uuid> (attachment.AttachmentId) [ items <uuid > ]
required
Array of objects (attachment.Attachment)
Array
contentLength
required
number
contentMD5
required
string
contentType
required
string
createdAt
required
string <date-time> (common.UTCDateTime)
expiresAt
string <date-time> (common.UTCDateTime)
fileName
required
string
id
required
string <uuid> (attachment.AttachmentId)
url
string (common.Url)
createdAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (questionnaire.ElementId)
order
required
string (questionnaire.ElementOrder)
organizationId
required
string <uuid> (organization.OrganizationId)
required
object (questionnaire.QuestionProps)
description
required
string (questionnaire.QuestionDescription)
required
questionnaire.QuestionTextParams (object) or questionnaire.QuestionSingleChoiceParams (object) or questionnaire.QuestionMultipleChoiceParams (object) or questionnaire.QuestionFileParams (object)
title
required
string (questionnaire.QuestionTitle)
questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)
questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)
type
required
string (questionnaire.ElementType)
Value: "QUESTION"
updatedAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "QuestionCreated"
source
required
string
Value: "zanshin.questionnaire.question"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "QuestionCreated",
  • "source": "zanshin.questionnaire.question",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

QuestionDeletedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Question)
attachmentIds
required
Array of strings <uuid> (attachment.AttachmentId) [ items <uuid > ]
required
Array of objects (attachment.Attachment)
Array
contentLength
required
number
contentMD5
required
string
contentType
required
string
createdAt
required
string <date-time> (common.UTCDateTime)
expiresAt
string <date-time> (common.UTCDateTime)
fileName
required
string
id
required
string <uuid> (attachment.AttachmentId)
url
string (common.Url)
createdAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (questionnaire.ElementId)
order
required
string (questionnaire.ElementOrder)
organizationId
required
string <uuid> (organization.OrganizationId)
required
object (questionnaire.QuestionProps)
description
required
string (questionnaire.QuestionDescription)
required
questionnaire.QuestionTextParams (object) or questionnaire.QuestionSingleChoiceParams (object) or questionnaire.QuestionMultipleChoiceParams (object) or questionnaire.QuestionFileParams (object)
title
required
string (questionnaire.QuestionTitle)
questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)
questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)
type
required
string (questionnaire.ElementType)
Value: "QUESTION"
updatedAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "QuestionDeleted"
source
required
string
Value: "zanshin.questionnaire.question"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "QuestionDeleted",
  • "source": "zanshin.questionnaire.question",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

QuestionnaireCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Questionnaire)
createdAt
required
string <date-time> (common.UTCDateTime)
description
required
string (questionnaire.QuestionnaireDescription)
id
required
string <uuid> (questionnaire.QuestionnaireId)
name
required
string
organizationId
required
string <uuid> (organization.OrganizationId)
status
required
string (questionnaire.QuestionnaireStatus)
Enum: "ACTIVE" "INACTIVE"
updatedAt
required
string <date-time> (common.UTCDateTime)
version
required
integer (questionnaire.QuestionnaireVersion)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "QuestionnaireCreated"
source
required
string
Value: "zanshin.questionnaire"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "QuestionnaireCreated",
  • "source": "zanshin.questionnaire",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

QuestionnairePublishedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Questionnaire)
createdAt
required
string <date-time> (common.UTCDateTime)
description
required
string (questionnaire.QuestionnaireDescription)
id
required
string <uuid> (questionnaire.QuestionnaireId)
name
required
string
organizationId
required
string <uuid> (organization.OrganizationId)
status
required
string (questionnaire.QuestionnaireStatus)
Enum: "ACTIVE" "INACTIVE"
updatedAt
required
string <date-time> (common.UTCDateTime)
version
required
integer (questionnaire.QuestionnaireVersion)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "QuestionnairePublished"
source
required
string
Value: "zanshin.questionnaire"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "QuestionnairePublished",
  • "source": "zanshin.questionnaire",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

QuestionnaireSentEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Questionnaire)
createdAt
required
string <date-time> (common.UTCDateTime)
description
required
string (questionnaire.QuestionnaireDescription)
id
required
string <uuid> (questionnaire.QuestionnaireId)
name
required
string
organizationId
required
string <uuid> (organization.OrganizationId)
status
required
string (questionnaire.QuestionnaireStatus)
Enum: "ACTIVE" "INACTIVE"
updatedAt
required
string <date-time> (common.UTCDateTime)
version
required
integer (questionnaire.QuestionnaireVersion)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "QuestionnaireSent"
source
required
string
Value: "zanshin.questionnaire"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "QuestionnaireSent",
  • "source": "zanshin.questionnaire",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

QuestionnaireUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Questionnaire)
createdAt
required
string <date-time> (common.UTCDateTime)
description
required
string (questionnaire.QuestionnaireDescription)
id
required
string <uuid> (questionnaire.QuestionnaireId)
name
required
string
organizationId
required
string <uuid> (organization.OrganizationId)
status
required
string (questionnaire.QuestionnaireStatus)
Enum: "ACTIVE" "INACTIVE"
updatedAt
required
string <date-time> (common.UTCDateTime)
version
required
integer (questionnaire.QuestionnaireVersion)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "QuestionnaireUpdated"
source
required
string
Value: "zanshin.questionnaire"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "QuestionnaireUpdated",
  • "source": "zanshin.questionnaire",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

QuestionUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (questionnaire.Question)
attachmentIds
required
Array of strings <uuid> (attachment.AttachmentId) [ items <uuid > ]
required
Array of objects (attachment.Attachment)
Array
contentLength
required
number
contentMD5
required
string
contentType
required
string
createdAt
required
string <date-time> (common.UTCDateTime)
expiresAt
string <date-time> (common.UTCDateTime)
fileName
required
string
id
required
string <uuid> (attachment.AttachmentId)
url
string (common.Url)
createdAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (questionnaire.ElementId)
order
required
string (questionnaire.ElementOrder)
organizationId
required
string <uuid> (organization.OrganizationId)
required
object (questionnaire.QuestionProps)
description
required
string (questionnaire.QuestionDescription)
required
questionnaire.QuestionTextParams (object) or questionnaire.QuestionSingleChoiceParams (object) or questionnaire.QuestionMultipleChoiceParams (object) or questionnaire.QuestionFileParams (object)
title
required
string (questionnaire.QuestionTitle)
questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)
questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)
type
required
string (questionnaire.ElementType)
Value: "QUESTION"
updatedAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "QuestionUpdated"
source
required
string
Value: "zanshin.questionnaire.question"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "QuestionUpdated",
  • "source": "zanshin.questionnaire.question",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

ScanCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (scan.Scan)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
organizationId
required
string <uuid> (organization.OrganizationId)
scanTargetId
required
string <uuid> (scantarget.ScanTargetId)
slot
required
string <date-time> (common.UTCDateTime)
status
required
string (scan.ScanStatus)
Enum: "RUNNING" "STOPED" "DONE" "FAIL"
object (scan.ScanSummary)
property name*
additional property
string
updatedAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "ScanCreated"
source
required
string
Value: "zanshin.scan"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "ScanCreated",
  • "source": "zanshin.scan",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

ScanTargetCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (scantarget.ScanTarget)

The template for picking properties.

account
string

DEPRECATED (will be on metadata) - The main identifier of the resource this scan target represents, such as an AWS account ID, Azure tenant ID, GCP project name or DNS domain; the format will depend on which kind of scan target this is

createdAt
required
string <date-time>

Date and time when this scan target was created

object

DEPRECATED (replace by metadata) - Credentials

property name*
additional property
string
currentScanSlot
string <date-time>

Date and time for current scan

groupId
string <uuid>

Scan Target Group unique identifier, which this scan target belongs

id
required
string <uuid>

Scan Target unique identifier

kind
required
string
Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"

The type of resource this scan target represents, either a cloud service provider or external attack surface asset

lastScan
string <date-time>

Date and time when this scan target was last scanned

lastScanSlot
string <date-time>

Date and time when this scan target was last scanned

name
required
string

The scan target display name as chosen during onboarding

notification
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"

List of alert severities that should send a notification when occur

organizationId
required
string <uuid>

Organization unique identifier

object

How frequently this scan target will be scheduled for scanning

frequency
required
string
timeOfDay
required
string
required
share.ShareAll (object) or share.ShareNone (object) or share.ShareFollowers (object)

Scan Target sharing and visibility configuration

Any of
mode
required
string
Value: "ALL"
status
required
string
Enum: "NEW" "ACTIVE" "SUSPENDED" "RUNNING" "ERROR" "INVALID_CREDENTIAL"

The current status of the scan target

tags
required
Array of strings (scantarget.ScanTargetTag)

List of identification tags added to this scan target, can be used for specific sharing modes

updatedAt
required
string <date-time>

Date and time when this scan target was last updated

id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "ScanTargetCreated"
source
required
string
Value: "zanshin.scanTarget"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "ScanTargetCreated",
  • "source": "zanshin.scanTarget",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

ScanTargetDeletedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (scantarget.ScanTarget)

The template for picking properties.

account
string

DEPRECATED (will be on metadata) - The main identifier of the resource this scan target represents, such as an AWS account ID, Azure tenant ID, GCP project name or DNS domain; the format will depend on which kind of scan target this is

createdAt
required
string <date-time>

Date and time when this scan target was created

object

DEPRECATED (replace by metadata) - Credentials

property name*
additional property
string
currentScanSlot
string <date-time>

Date and time for current scan

groupId
string <uuid>

Scan Target Group unique identifier, which this scan target belongs

id
required
string <uuid>

Scan Target unique identifier

kind
required
string
Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"

The type of resource this scan target represents, either a cloud service provider or external attack surface asset

lastScan
string <date-time>

Date and time when this scan target was last scanned

lastScanSlot
string <date-time>

Date and time when this scan target was last scanned

name
required
string

The scan target display name as chosen during onboarding

notification
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"

List of alert severities that should send a notification when occur

organizationId
required
string <uuid>

Organization unique identifier

object

How frequently this scan target will be scheduled for scanning

frequency
required
string
timeOfDay
required
string
required
share.ShareAll (object) or share.ShareNone (object) or share.ShareFollowers (object)

Scan Target sharing and visibility configuration

Any of
mode
required
string
Value: "ALL"
status
required
string
Enum: "NEW" "ACTIVE" "SUSPENDED" "RUNNING" "ERROR" "INVALID_CREDENTIAL"

The current status of the scan target

tags
required
Array of strings (scantarget.ScanTargetTag)

List of identification tags added to this scan target, can be used for specific sharing modes

updatedAt
required
string <date-time>

Date and time when this scan target was last updated

id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "ScanTargetDeleted"
source
required
string
Value: "zanshin.scanTarget"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "ScanTargetDeleted",
  • "source": "zanshin.scanTarget",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

ScanTargetUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (scantarget.ScanTarget)

The template for picking properties.

account
string

DEPRECATED (will be on metadata) - The main identifier of the resource this scan target represents, such as an AWS account ID, Azure tenant ID, GCP project name or DNS domain; the format will depend on which kind of scan target this is

createdAt
required
string <date-time>

Date and time when this scan target was created

object

DEPRECATED (replace by metadata) - Credentials

property name*
additional property
string
currentScanSlot
string <date-time>

Date and time for current scan

groupId
string <uuid>

Scan Target Group unique identifier, which this scan target belongs

id
required
string <uuid>

Scan Target unique identifier

kind
required
string
Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"

The type of resource this scan target represents, either a cloud service provider or external attack surface asset

lastScan
string <date-time>

Date and time when this scan target was last scanned

lastScanSlot
string <date-time>

Date and time when this scan target was last scanned

name
required
string

The scan target display name as chosen during onboarding

notification
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"

List of alert severities that should send a notification when occur

organizationId
required
string <uuid>

Organization unique identifier

object

How frequently this scan target will be scheduled for scanning

frequency
required
string
timeOfDay
required
string
required
share.ShareAll (object) or share.ShareNone (object) or share.ShareFollowers (object)

Scan Target sharing and visibility configuration

Any of
mode
required
string
Value: "ALL"
status
required
string
Enum: "NEW" "ACTIVE" "SUSPENDED" "RUNNING" "ERROR" "INVALID_CREDENTIAL"

The current status of the scan target

tags
required
Array of strings (scantarget.ScanTargetTag)

List of identification tags added to this scan target, can be used for specific sharing modes

updatedAt
required
string <date-time>

Date and time when this scan target was last updated

id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "ScanTargetUpdated"
source
required
string
Value: "zanshin.scanTarget"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "ScanTargetUpdated",
  • "source": "zanshin.scanTarget",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

ScanUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (scan.Scan)

The template for picking properties.

createdAt
required
string <date-time> (common.UTCDateTime)
organizationId
required
string <uuid> (organization.OrganizationId)
scanTargetId
required
string <uuid> (scantarget.ScanTargetId)
slot
required
string <date-time> (common.UTCDateTime)
status
required
string (scan.ScanStatus)
Enum: "RUNNING" "STOPED" "DONE" "FAIL"
object (scan.ScanSummary)
property name*
additional property
string
updatedAt
required
string <date-time> (common.UTCDateTime)
id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "ScanUpdated"
source
required
string
Value: "zanshin.scan"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "ScanUpdated",
  • "source": "zanshin.scan",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

WebhookCreatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (webhook.Webhook)

Webhook

authorizationType
string
Enum: "NONE" "API_KEY" "BASIC"

The authorization type for the webhook

createdAt
required
string <date-time>

Date and time when was created

description
required
string

The webhook description

required
Array of alert.AlertEventName (string) or alert.AlertCommentEventName (string) or questionnaire.AnswerEventName (string) or questionnaire.AssessmentEventName (string) or questionnaire.AssessmentCommentEventName (string) or follow.FollowerEventName (string) or follow.FollowingEventName (string) or member.MemberEventName (string) or organization.OrganizationEventName (string) or questionnaire.QuestionEventName (string) or questionnaire.QuestionnaireEventName (string) or scan.ScanEventName (string) or scantarget.ScanTargetEventName (string) or webhook.WebhookEventName (string)

List of events that trigger this webhook

Array
Any of
string (alert.AlertEventName)
Enum: "AlertCreated" "AlertUpdated" "AlertFollowingCreated" "AlertFollowingUpdated"
id
required
string <uuid>

Webhook unique identifier

required
object

Additional metadata for the webhook

property name*
additional property
string
name
required
string

The webhook name

organizationId
required
string <uuid>

Organization unique identifier

status
required
string
Enum: "NEW" "ACTIVE" "SUSPENDED" "ERROR"

Current status of the webhook

updatedAt
required
string <date-time>

Date and time when was last updated

url
required
string

The webhook URL endpoint

id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "WebhookCreated"
source
required
string
Value: "zanshin.webhook"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "WebhookCreated",
  • "source": "zanshin.webhook",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

WebhookDeletedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (webhook.Webhook)

Webhook

authorizationType
string
Enum: "NONE" "API_KEY" "BASIC"

The authorization type for the webhook

createdAt
required
string <date-time>

Date and time when was created

description
required
string

The webhook description

required
Array of alert.AlertEventName (string) or alert.AlertCommentEventName (string) or questionnaire.AnswerEventName (string) or questionnaire.AssessmentEventName (string) or questionnaire.AssessmentCommentEventName (string) or follow.FollowerEventName (string) or follow.FollowingEventName (string) or member.MemberEventName (string) or organization.OrganizationEventName (string) or questionnaire.QuestionEventName (string) or questionnaire.QuestionnaireEventName (string) or scan.ScanEventName (string) or scantarget.ScanTargetEventName (string) or webhook.WebhookEventName (string)

List of events that trigger this webhook

Array
Any of
string (alert.AlertEventName)
Enum: "AlertCreated" "AlertUpdated" "AlertFollowingCreated" "AlertFollowingUpdated"
id
required
string <uuid>

Webhook unique identifier

required
object

Additional metadata for the webhook

property name*
additional property
string
name
required
string

The webhook name

organizationId
required
string <uuid>

Organization unique identifier

status
required
string
Enum: "NEW" "ACTIVE" "SUSPENDED" "ERROR"

Current status of the webhook

updatedAt
required
string <date-time>

Date and time when was last updated

url
required
string

The webhook URL endpoint

id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "WebhookDeleted"
source
required
string
Value: "zanshin.webhook"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "WebhookDeleted",
  • "source": "zanshin.webhook",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

WebhookUpdatedEvent Webhook

Request Body schema: application/json
createdAt
required
string <date-time> (common.UTCDateTime)
required
object (webhook.Webhook)

Webhook

authorizationType
string
Enum: "NONE" "API_KEY" "BASIC"

The authorization type for the webhook

createdAt
required
string <date-time>

Date and time when was created

description
required
string

The webhook description

required
Array of alert.AlertEventName (string) or alert.AlertCommentEventName (string) or questionnaire.AnswerEventName (string) or questionnaire.AssessmentEventName (string) or questionnaire.AssessmentCommentEventName (string) or follow.FollowerEventName (string) or follow.FollowingEventName (string) or member.MemberEventName (string) or organization.OrganizationEventName (string) or questionnaire.QuestionEventName (string) or questionnaire.QuestionnaireEventName (string) or scan.ScanEventName (string) or scantarget.ScanTargetEventName (string) or webhook.WebhookEventName (string)

List of events that trigger this webhook

Array
Any of
string (alert.AlertEventName)
Enum: "AlertCreated" "AlertUpdated" "AlertFollowingCreated" "AlertFollowingUpdated"
id
required
string <uuid>

Webhook unique identifier

required
object

Additional metadata for the webhook

property name*
additional property
string
name
required
string

The webhook name

organizationId
required
string <uuid>

Organization unique identifier

status
required
string
Enum: "NEW" "ACTIVE" "SUSPENDED" "ERROR"

Current status of the webhook

updatedAt
required
string <date-time>

Date and time when was last updated

url
required
string

The webhook URL endpoint

id
required
string <uuid> (common.EventId)
required
object
property name*
additional property
string
name
required
string
Value: "WebhookUpdated"
source
required
string
Value: "zanshin.webhook"
version
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "WebhookUpdated",
  • "source": "zanshin.webhook",
  • "version": 0,
  • "data": {
    },
  • "metadata": { },
  • "createdAt": "2019-08-24T14:15:22Z"
}

Follower

Accept follower request

Accept follower request

Permission required: followingOrganizations: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
followerId
required
string <uuid> (organization.OrganizationId)

Follower organization unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request POST \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/followers/{followerId}/requests/accept \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "picture": "string",
  • "status": "ACTIVE",
  • "followMode": "COOPERATIVE",
  • "requestedBy": "FOLLOWER",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Create follower request

Create follower request

Permission required: followerOrganizations: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Follower request data

followerBusinessImpact
string (follow.BusinessImpact)
Enum: "SEVERE" "SIGNIFICANT" "MODERATE" "MINOR" "MINIMAL" "NOT_DEFINED"
followingId
string <uuid> (organization.OrganizationId)
followMode
string (follow.FollowMode)
Enum: "COOPERATIVE" "ANONYMOUS"
followTags
Array of strings (follow.FollowTag)
object (organization.OrganizationCreate)

The template for picking properties.

email
string (common.Email)
name
required
string
pictureId
string <uuid> (common.Id)
Array of objects (scantarget.ScanTargetSuggestionCreate)
Array
account
required
string

Scan target suggestion account, for now only domains, should contain only the second-level and top-level domain, without the protocol (https://)

kind
required
string
Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"
Array of objects (user.UserContact)
Array
email
required
string (common.Email)
name
required
string
phone
string

Responses

Request samples

Content type
application/json
{
  • "followingId": "6338e9fd-6a02-4721-9c37-b1e04d194fe9",
  • "followMode": "COOPERATIVE",
  • "followTags": [
    ],
  • "userContacts": [
    ],
  • "organizationInformation": {
    },
  • "scanTargetSuggestions": [
    ],
  • "followerBusinessImpact": "SEVERE"
}

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Decline follower request

Decline follower request

Permission required: followingOrganizations: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
followerId
required
string <uuid> (organization.OrganizationId)

Follower organization unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request POST \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/followers/{followerId}/requests/decline \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "picture": "string",
  • "status": "ACTIVE",
  • "followMode": "COOPERATIVE",
  • "requestedBy": "FOLLOWER",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete follower relationship

Delete follower relationship

Permission required: followerOrganizations: FULL_ACCESSs

Authorizations:
ZanshinAuth
path Parameters
followerId
required
string <uuid> (organization.OrganizationId)

Follower organization unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request DELETE \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/followers/{followerId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Delete follower request

Delete follower request by token

Permission required: followerOrganizations: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

token
required
string

Request token

Responses

Request samples 

curl --request DELETE \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/followers/requests/{token} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Get follower

Get follower by ID

Permission required: followerOrganizations: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
followerId
required
string <uuid> (organization.OrganizationId)

Follower organization unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/followers/{followerId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "picture": "string",
  • "share": {
    },
  • "status": "ACTIVE",
  • "score": 0,
  • "createdAt": "2019-08-24T14:15:22Z"
}

Get follower request info

Get follower request info by token

Permission required: followerOrganizations: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

token
required
string

Request token

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/followers/requests/{token} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "picture": "string",
  • "status": "ACTIVE",
  • "followMode": "COOPERATIVE",
  • "requestedBy": "FOLLOWER",
  • "createdAt": "2019-08-24T14:15:22Z"
}

List follower requests

Get all follower requests

Permission required: followerOrganizations: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/followers/requests \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • {
    }
]

List followers

Get all cooperation followers

Permission required: followerOrganizations: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/followers \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • {
    }
]

Update follower

Update follower

Permission required: followerOrganizations: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
followerId
required
string <uuid> (organization.OrganizationId)

Follower organization unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Updated follower data

object (share.ShareScanTargetTags)
mode
required
string
Value: "SCAN_TARGET_TAGS"
scanTargetTags
required
Array of strings (scantarget.ScanTargetTag)

Responses

Request samples

Content type
application/json
{
  • "share": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "picture": "string",
  • "share": {
    },
  • "status": "ACTIVE",
  • "score": 0,
  • "createdAt": "2019-08-24T14:15:22Z"
}

Following

Accept following request

Accept following request

Permission required: followerOrganizations: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
followingId
required
string <uuid> (organization.OrganizationId)

Following organization unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request POST \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/following/requests/{followingId}/accept \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Create following request

Create following request

Permission required: followingOrganizations: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Following request data

followerBusinessImpact
string (follow.BusinessImpact)
Enum: "SEVERE" "SIGNIFICANT" "MODERATE" "MINOR" "MINIMAL" "NOT_DEFINED"
followingId
string <uuid> (organization.OrganizationId)
followMode
string (follow.FollowMode)
Enum: "COOPERATIVE" "ANONYMOUS"
followTags
Array of strings (follow.FollowTag)
object (organization.OrganizationCreate)

The template for picking properties.

email
string (common.Email)
name
required
string
pictureId
string <uuid> (common.Id)
Array of objects (scantarget.ScanTargetSuggestionCreate)
Array
account
required
string

Scan target suggestion account, for now only domains, should contain only the second-level and top-level domain, without the protocol (https://)

kind
required
string
Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"
Array of objects (user.UserContact)
Array
email
required
string (common.Email)
name
required
string
phone
string

Responses

Request samples

Content type
application/json
{
  • "followingId": "6338e9fd-6a02-4721-9c37-b1e04d194fe9",
  • "followMode": "COOPERATIVE",
  • "followTags": [
    ],
  • "userContacts": [
    ],
  • "organizationInformation": {
    },
  • "scanTargetSuggestions": [
    ],
  • "followerBusinessImpact": "SEVERE"
}

Response samples

Content type
application/json
{
  • "followingId": "6338e9fd-6a02-4721-9c37-b1e04d194fe9",
  • "followerId": "62213f7a-f0bf-47a0-a6dd-74e2885412b0",
  • "followingShare": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "followMode": "COOPERATIVE",
  • "requestedBy": "FOLLOWER",
  • "userContacts": [
    ]
}

Decline following request

Decline following request

Permission required: followerOrganizations: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
followingId
required
string <uuid> (organization.OrganizationId)

Following organization unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request POST \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/following/requests/{followingId}/decline \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Delete following relationship

Delete following relationship

Permission required: followingOrganizations: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
followingId
required
string <uuid> (organization.OrganizationId)

Following organization unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request DELETE \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/following/{followingId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Get following organization

Get following organization by ID

Permission required: followingOrganizations: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
followingId
required
string <uuid> (organization.OrganizationId)

Following organization unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/following/{followingId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "picture": "string",
  • "status": "ACTIVE",
  • "tags": [
    ],
  • "score": 0,
  • "followMode": "COOPERATIVE",
  • "requestedBy": "FOLLOWER",
  • "followerBusinessImpact": "SEVERE",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Get following request token

Get following request token

Permission required: followingOrganizations: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/following/requests/token \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "token": "string"
}

Get following tags

Get all following tags

Permission required: followingOrganizations: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/following/tags \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • "string"
]

List following organizations

Get all following organizations

Permission required: followingOrganizations: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/following \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • {
    }
]

List following requests

Get all following requests

Permission required: followingOrganizations: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/following/requests \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • {
    }
]

Update following organization

Update following organization

Permission required: followingOrganizations: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
followingId
required
string <uuid> (organization.OrganizationId)

Following organization unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Updated following data

followerBusinessImpact
string (follow.BusinessImpact)
Enum: "SEVERE" "SIGNIFICANT" "MODERATE" "MINOR" "MINIMAL" "NOT_DEFINED"
followMode
string (follow.FollowMode)
Enum: "COOPERATIVE" "ANONYMOUS"
tags
Array of strings (follow.FollowTag)

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ],
  • "followMode": "COOPERATIVE",
  • "followerBusinessImpact": "SEVERE"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "picture": "string",
  • "status": "ACTIVE",
  • "tags": [
    ],
  • "score": 0,
  • "followMode": "COOPERATIVE",
  • "requestedBy": "FOLLOWER",
  • "followerBusinessImpact": "SEVERE",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Member

Create member invite

Create member invite

Permission required: organizationMembers: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Invite data

email
required
string (common.Email)
roles
required
Array of strings (member.MemberRole)
Items Value: "ADMIN"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "organizationName": "string",
  • "email": "string",
  • "roles": [
    ],
  • "expiredAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Delete member invite

Delete member invite

Permission required: organizationMembers: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
email
required
string (common.Email)

Member email address

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request DELETE \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/invites/{email} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Get member invite

Get member invite by email

Permission required: organizationMembers: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
email
required
string (common.Email)

Member email address

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/invites/{email} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "organizationName": "string",
  • "email": "string",
  • "roles": [
    ],
  • "expiredAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z"
}

List member invites

Get all member invites

Permission required: organizationMembers: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/invites \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • {
    }
]

List members

Get all members

Permission required: organizationMembers: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/members \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • {
    }
]

Remove member

Remove member from organization

Permission required: organizationMembers: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
memberId
required
string <uuid> (user.UserId)

Member unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request DELETE \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/members/{memberId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Resend member invite

Resend member invite

Permission required: organizationMembers: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
email
required
string (common.Email)

Member email address

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request POST \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/invites/{email}/resend \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Reset member MFA

Reset member MFA

Permission required: organizationMembers: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
memberId
required
string <uuid> (user.UserId)

Member unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request POST \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/members/{memberId}/mfa/reset \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Reset member password

Reset member password

Permission required: organizationMembers: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
memberId
required
string <uuid> (user.UserId)

Member unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request POST \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/members/{memberId}/password/reset \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Update member

Update member

Permission required: organizationMembers: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
memberId
required
string <uuid> (user.UserId)

Member unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Updated member data

roles
Array of strings (member.MemberRole)
Items Value: "ADMIN"

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Organization

Get organization

Get Organization

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "picture": "string",
  • "email": "string",
  • "features": [
    ],
  • "status": "ACTIVE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "score": 0
}

List organizations

List Organizations

Authorizations:
ZanshinAuth
query Parameters
cursor
string
size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations?size={INTEGER}&cursor={STRING}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Questionnaire

Clone questionnaire

Clone questionnaire version

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)

Questionnaire version

Request Body schema: application/json
required

Clone data

name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "version": 0,
  • "name": "string",
  • "description": "string",
  • "status": "ACTIVE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create questionnaire

Create a new questionnaire

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Questionnaire data

Array of objects (questionnaire.AssessmentContactInformation)
Array
email
required
string (common.Email)
name
required
string
phone
string (common.PhoneNumber)
description
required
string (questionnaire.QuestionnaireDescription)
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "contactInformation": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "version": 0,
  • "name": "string",
  • "description": "string",
  • "status": "ACTIVE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create questionnaire element

Create element for questionnaire

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Request Body schema: application/json
required

Element data

description
required
string (questionnaire.QuestionDescription)
required
questionnaire.QuestionTextParams (object) or questionnaire.QuestionSingleChoiceParams (object) or questionnaire.QuestionMultipleChoiceParams (object) or questionnaire.QuestionFileParams (object)
Any of
required
boolean
type
required
string
Value: "TEXT"
title
required
string (questionnaire.QuestionTitle)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "questionnaireVersion": 0,
  • "order": "string",
  • "type": "QUESTION",
  • "props": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "attachmentIds": [
    ],
  • "attachments": [
    ]
}

Create questionnaire question

Create question for questionnaire (deprecated)

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Request Body schema: application/json
required

Question data

description
required
string (questionnaire.QuestionDescription)
required
questionnaire.QuestionTextParams (object) or questionnaire.QuestionSingleChoiceParams (object) or questionnaire.QuestionMultipleChoiceParams (object) or questionnaire.QuestionFileParams (object)
Any of
required
boolean
type
required
string
Value: "TEXT"
title
required
string (questionnaire.QuestionTitle)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "questionnaireVersion": 0,
  • "order": "string",
  • "type": "QUESTION",
  • "props": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "attachmentIds": [
    ],
  • "attachments": [
    ]
}

Create questionnaire schedule

Create questionnaire schedule

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Request Body schema: application/json
required

Schedule data

Array of objects (questionnaire.AssessmentContactInformation)
Array
email
required
string (common.Email)
name
required
string
phone
string (common.PhoneNumber)
dueDays
required
integer
frequency
required
string (questionnaire.QuestionnaireScheduleFrequency)
Enum: "MONTHLY" "QUARTERLY" "SEMESTRAL" "ANNUALLY"
name
required
string
receiverTags
required
Array of strings (common.Tag)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "frequency": "MONTHLY",
  • "dueDays": 0,
  • "receiverTags": [
    ],
  • "contactInformation": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "frequency": "MONTHLY",
  • "dueDays": 0,
  • "receiverTags": [
    ],
  • "contactInformation": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete questionnaire element

Delete element

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
elementId
required
string <uuid> (questionnaire.ElementId)

Element unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Responses

Request samples 

curl --request DELETE \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/elements/{elementId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Delete questionnaire question

Delete question

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionId
required
string <uuid> (questionnaire.ElementId)

Question unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Responses

Request samples 

curl --request DELETE \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/questions/{questionId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Delete questionnaire schedule

Delete questionnaire schedule

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

questionnaireScheduleId
required
string <uuid> (questionnaire.QuestionnaireScheduleId)

Schedule unique identifier

Responses

Request samples 

curl --request DELETE \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/schedules/{questionnaireScheduleId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Get questionnaire

Get questionnaire by ID

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "version": 0,
  • "name": "string",
  • "description": "string",
  • "status": "ACTIVE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get questionnaire element

Get element by ID

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
elementId
required
string <uuid> (questionnaire.ElementId)

Element unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/elements/{elementId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "questionnaireVersion": 0,
  • "order": "string",
  • "type": "QUESTION",
  • "props": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "attachmentIds": [
    ],
  • "attachments": [
    ]
}

Get questionnaire question

Get question by ID

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionId
required
string <uuid> (questionnaire.ElementId)

Question unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/questions/{questionId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "questionnaireVersion": 0,
  • "order": "string",
  • "type": "QUESTION",
  • "props": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "attachmentIds": [
    ],
  • "attachments": [
    ]
}

Get questionnaire schedule

Get questionnaire schedule by ID

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

questionnaireScheduleId
required
string <uuid> (questionnaire.QuestionnaireScheduleId)

Schedule unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/schedules/{questionnaireScheduleId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "frequency": "MONTHLY",
  • "dueDays": 0,
  • "receiverTags": [
    ],
  • "contactInformation": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get questionnaire version

Get specific questionnaire version

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)

Questionnaire version

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/versions/{questionnaireVersion} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "version": 0,
  • "name": "string",
  • "description": "string",
  • "status": "ACTIVE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

List questionnaire elements

Get all elements for questionnaire

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

query Parameters
page
integer <uint16> >= 1
Default: 1
size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/elements?size={INTEGER}&page={INTEGER}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List questionnaire questions

Get all questions for questionnaire

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

query Parameters
page
integer <uint16> >= 1
Default: 1
required
boolean

Filter by required status

size
integer <uint16> [ 1 .. 1000 ]
Default: 25
title
string

Filter by title

type
string (questionnaire.QuestionType)
Enum: "TEXT" "SINGLE_CHOICE" "MULTIPLE_CHOICE" "FILE"

Filter by question type

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/questions?required=SOME_BOOLEAN_VALUE&title={STRING}&type={STRING}&size={INTEGER}&page={INTEGER}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List questionnaire schedules

List questionnaire schedules

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

query Parameters
page
integer <uint16> >= 1
Default: 1
size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/schedules?size={INTEGER}&page={INTEGER}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List questionnaire version elements

Get elements for specific questionnaire version

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)

Questionnaire version

query Parameters
page
integer <uint16> >= 1
Default: 1
size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/versions/{questionnaireVersion}/elements?size={INTEGER}&page={INTEGER}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List questionnaire version questions

Get questions for specific questionnaire version

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

questionnaireVersion
required
integer (questionnaire.QuestionnaireVersion)

Questionnaire version

query Parameters
page
integer <uint16> >= 1
Default: 1
size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/versions/{questionnaireVersion}/questions?size={INTEGER}&page={INTEGER}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List questionnaire versions

Get questionnaire versions

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

query Parameters
page
integer <uint16> >= 1
Default: 1
size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/versions?size={INTEGER}&page={INTEGER}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List questionnaires

List questionnaires

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
name
string

Filter by name

order
string

Sort order

page
integer <uint16> >= 1
Default: 1
size
integer <uint16> [ 1 .. 1000 ]
Default: 25
sort
string

Sort field

status
string (questionnaire.QuestionnaireStatus)
Enum: "ACTIVE" "INACTIVE"

Filter by status

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires?order={STRING}&sort={STRING}&name={STRING}&status={STRING}&size={INTEGER}&page={INTEGER}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Publish questionnaire

Publish questionnaire

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Responses

Request samples 

curl --request POST \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/questionnaires/{questionnaireId}/publish \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "version": 0,
  • "name": "string",
  • "description": "string",
  • "status": "ACTIVE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Send questionnaire

Send questionnaire

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Request Body schema: application/json
required

Send questionnaire data

required
Array of objects (questionnaire.AssessmentContactInformation)
Array
email
required
string (common.Email)
name
required
string
phone
string (common.PhoneNumber)
dueDate
required
string <date-time> (common.UTCDateTime)
receiverId
required
string <uuid> (organization.OrganizationId)

Responses

Request samples

Content type
application/json
{
  • "receiverId": "2ec2e5a9-5968-4568-baf3-a525f7f8b9a6",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "contactInformation": [
    ]
}

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Update questionnaire

Update questionnaire

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Request Body schema: application/json
required

Updated questionnaire data

Array of objects (questionnaire.AssessmentContactInformation)
Array
email
required
string (common.Email)
name
required
string
phone
string (common.PhoneNumber)
description
string (questionnaire.QuestionnaireDescription)
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "contactInformation": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "version": 0,
  • "name": "string",
  • "description": "string",
  • "status": "ACTIVE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update questionnaire element

Update element

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
elementId
required
string <uuid> (questionnaire.ElementId)

Element unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Request Body schema: application/json
required

Updated element data

description
required
string (questionnaire.QuestionDescription)
required
questionnaire.QuestionTextParams (object) or questionnaire.QuestionSingleChoiceParams (object) or questionnaire.QuestionMultipleChoiceParams (object) or questionnaire.QuestionFileParams (object)
Any of
required
boolean
type
required
string
Value: "TEXT"
title
required
string (questionnaire.QuestionTitle)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "questionnaireVersion": 0,
  • "order": "string",
  • "type": "QUESTION",
  • "props": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "attachmentIds": [
    ],
  • "attachments": [
    ]
}

Update questionnaire question

Update question

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionId
required
string <uuid> (questionnaire.ElementId)

Question unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Request Body schema: application/json
required

Updated question data

description
required
string (questionnaire.QuestionDescription)
required
questionnaire.QuestionTextParams (object) or questionnaire.QuestionSingleChoiceParams (object) or questionnaire.QuestionMultipleChoiceParams (object) or questionnaire.QuestionFileParams (object)
Any of
required
boolean
type
required
string
Value: "TEXT"
title
required
string (questionnaire.QuestionTitle)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "questionnaireVersion": 0,
  • "order": "string",
  • "type": "QUESTION",
  • "props": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "attachmentIds": [
    ],
  • "attachments": [
    ]
}

Update questionnaire schedule

Update questionnaire schedule

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

questionnaireScheduleId
required
string <uuid> (questionnaire.QuestionnaireScheduleId)

Schedule unique identifier

Request Body schema: application/json
required

Updated schedule data

Array of objects (questionnaire.AssessmentContactInformation)
Array
email
required
string (common.Email)
name
required
string
phone
string (common.PhoneNumber)
dueDays
integer
frequency
string (questionnaire.QuestionnaireScheduleFrequency)
Enum: "MONTHLY" "QUARTERLY" "SEMESTRAL" "ANNUALLY"
name
string
receiverTags
Array of strings (common.Tag)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "frequency": "MONTHLY",
  • "dueDays": 0,
  • "receiverTags": [
    ],
  • "contactInformation": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "frequency": "MONTHLY",
  • "dueDays": 0,
  • "receiverTags": [
    ],
  • "contactInformation": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update questionnaire status

Update questionnaire status

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionnaireId
required
string <uuid> (questionnaire.QuestionnaireId)

Questionnaire unique identifier

Request Body schema: application/json
required

Status update data

status
required
string (questionnaire.QuestionnaireStatus)
Enum: "ACTIVE" "INACTIVE"

Responses

Request samples

Content type
application/json
{
  • "status": "ACTIVE"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "version": 0,
  • "name": "string",
  • "description": "string",
  • "status": "ACTIVE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Questionnaire Assessment

Create assessment comment

Create assessment comment

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Comment data

attachmentIds
Array of strings <uuid> (attachment.AttachmentId) [ items <uuid > ]
content
required
string (common.Markdown)

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "attachmentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "assessmentId": "673a0734-83cc-415f-a672-f8ef54b2727c",
  • "questionId": "ffa0420e-f70b-4e5b-99a0-434bff860467",
  • "content": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "attachmentIds": [
    ],
  • "attachments": [
    ]
}

Create question answer

Create answer for question

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionId
required
string <uuid> (questionnaire.ElementId)

Question unique identifier

Request Body schema: application/json
required

Answer data

attachmentIds
Array of strings <uuid> (attachment.AttachmentId) [ items <uuid > ]
required
questionnaire.AnswerEmptyContent (object) or questionnaire.AnswerTextContent (object) or questionnaire.AnswerSingleChoiceContent (object) or questionnaire.AnswerMultipleChoiceContent (object) or questionnaire.AnswerFileContent (object)
Any of
type
required
string
Value: "EMPTY"

Responses

Request samples

Content type
application/json
{
  • "content": {
    },
  • "attachmentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "assessmentId": "673a0734-83cc-415f-a672-f8ef54b2727c",
  • "questionId": "ffa0420e-f70b-4e5b-99a0-434bff860467",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "questionnaireVersion": 0,
  • "senderId": "6b2f63ba-164c-48c9-87b1-690cee2b3da3",
  • "receiverId": "2ec2e5a9-5968-4568-baf3-a525f7f8b9a6",
  • "content": [
    ],
  • "status": "NEW",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create question comment

Create question comment

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionId
required
string <uuid> (questionnaire.ElementId)

Question unique identifier

Request Body schema: application/json
required

Comment data

attachmentIds
Array of strings <uuid> (attachment.AttachmentId) [ items <uuid > ]
content
required
string (common.Markdown)

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "attachmentIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "assessmentId": "673a0734-83cc-415f-a672-f8ef54b2727c",
  • "questionId": "ffa0420e-f70b-4e5b-99a0-434bff860467",
  • "content": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "attachmentIds": [
    ],
  • "attachments": [
    ]
}

Get assessment

Get assessment by ID

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/assessments/{assessmentId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "questionnaireVersion": 0,
  • "senderId": "6b2f63ba-164c-48c9-87b1-690cee2b3da3",
  • "receiverId": "2ec2e5a9-5968-4568-baf3-a525f7f8b9a6",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "firstRequestedReviewAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "status": "NEW",
  • "contactInformation": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get assessment element

Get assessment element by ID

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

elementId
required
string <uuid> (questionnaire.ElementId)

Element unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/assessments/{assessmentId}/elements/{elementId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "questionnaireVersion": 0,
  • "order": "string",
  • "type": "QUESTION",
  • "props": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get assessment history

Gets assessment history

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
cursor
string
size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/assessments/{assessmentId}/history?size={INTEGER}&cursor={STRING}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Get assessment question history

Gets assessment question history

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
cursor
string
questionId
string <uuid> (questionnaire.ElementId)

Question unique identifier filter

size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/assessments/{assessmentId}/history/questions?questionId={STRING}&size={INTEGER}&cursor={STRING}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Get question answer

Get question answer by ID

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionId
required
string <uuid> (questionnaire.ElementId)

Question unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/assessments/{assessmentId}/questions/{questionId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "assessmentId": "673a0734-83cc-415f-a672-f8ef54b2727c",
  • "questionId": "ffa0420e-f70b-4e5b-99a0-434bff860467",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "questionnaireVersion": 0,
  • "senderId": "6b2f63ba-164c-48c9-87b1-690cee2b3da3",
  • "receiverId": "2ec2e5a9-5968-4568-baf3-a525f7f8b9a6",
  • "answer": {
    },
  • "question": {
    }
}

List assessment comments

Get all assessment comments

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
page
integer <uint16> >= 1
Default: 1
size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/assessments/{assessmentId}/comments?size={INTEGER}&page={INTEGER}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List assessment elements

Get all assessment elements

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
page
integer <uint16> >= 1
Default: 1
size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/assessments/{assessmentId}/elements?size={INTEGER}&page={INTEGER}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List assessment question answers

Get all question answers for assessment

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
order
string

Sort order

page
integer <uint16> >= 1
Default: 1
size
integer <uint16> [ 1 .. 1000 ]
Default: 25
sort
string

Sort field

status
string (questionnaire.AnswerStatus)
Enum: "NEW" "REQUESTED_REVIEW" "REQUESTED_CLARIFICATION" "APPROVED" "REJECTED" "SKIPPED"

Filter by answer status

title
string

Filter by question title

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/assessments/{assessmentId}/questions?order={STRING}&sort={STRING}&status={STRING}&title={STRING}&size={INTEGER}&page={INTEGER}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List assessments

List assessments

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
page
integer <uint16> >= 1
Default: 1
size
integer <uint16> [ 1 .. 1000 ]
Default: 25
Request Body schema: application/json
required

Filter criteria

createdAfterEnd
string (common.UTCDate)
createdAfterStart
string (common.UTCDate)
dueDateAfterEnd
string (common.UTCDate)
dueDateAfterStart
string (common.UTCDate)
order
string (common.Sort)
Enum: "DESC" "ASC"
questionnaireName
string
receiverName
string
senderName
string
sort
string
status
string (questionnaire.AssessmentStatus)
Enum: "NEW" "REQUESTED_REVIEW" "REQUESTED_CLARIFICATION" "APPROVED" "REJECTED"

Responses

Request samples

Content type
application/json
{
  • "order": "DESC",
  • "sort": "string",
  • "questionnaireName": "string",
  • "status": "NEW",
  • "senderName": "string",
  • "receiverName": "string",
  • "createdAfterStart": "string",
  • "createdAfterEnd": "string",
  • "dueDateAfterStart": "string",
  • "dueDateAfterEnd": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

List question comments

Get all question comments

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionId
required
string <uuid> (questionnaire.ElementId)

Question unique identifier

query Parameters
page
integer <uint16> >= 1
Default: 1
size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/assessments/{assessmentId}/questions/{questionId}/comments?size={INTEGER}&page={INTEGER}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Summarizes assessment

Get assessment dashboard summary

Permission required: followingQuestionnaires: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
createdAfterEnd
string (common.UTCDate)

Filter by created date end

createdAfterStart
string (common.UTCDate)

Filter by created date start

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/summary/assessments?createdAfterStart={STRING}&createdAfterEnd={STRING}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "totalAssessments": 0,
  • "assessmentsByStatus": { },
  • "assessmentsByMonth": { }
}

Update answer status

Update answer status

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

questionId
required
string <uuid> (questionnaire.ElementId)

Question unique identifier

Request Body schema: application/json
required

Answer status update data

status
required
string (questionnaire.AnswerStatus)
Enum: "NEW" "REQUESTED_REVIEW" "REQUESTED_CLARIFICATION" "APPROVED" "REJECTED" "SKIPPED"

Responses

Request samples

Content type
application/json
{
  • "status": "NEW"
}

Response samples

Content type
application/json
{
  • "assessmentId": "673a0734-83cc-415f-a672-f8ef54b2727c",
  • "questionId": "ffa0420e-f70b-4e5b-99a0-434bff860467",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "questionnaireVersion": 0,
  • "senderId": "6b2f63ba-164c-48c9-87b1-690cee2b3da3",
  • "receiverId": "2ec2e5a9-5968-4568-baf3-a525f7f8b9a6",
  • "content": [
    ],
  • "status": "NEW",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update assessment status

Update assessment status

Permission required: followingQuestionnaires: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
assessmentId
required
string <uuid> (questionnaire.AssessmentId)

Assessment unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Status update data

status
required
string (questionnaire.AssessmentStatus)
Enum: "NEW" "REQUESTED_REVIEW" "REQUESTED_CLARIFICATION" "APPROVED" "REJECTED"

Responses

Request samples

Content type
application/json
{
  • "status": "NEW"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "questionnaireId": "9abce9e8-8cd1-466c-8c53-3b67c390ab33",
  • "questionnaireVersion": 0,
  • "senderId": "6b2f63ba-164c-48c9-87b1-690cee2b3da3",
  • "receiverId": "2ec2e5a9-5968-4568-baf3-a525f7f8b9a6",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "firstRequestedReviewAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "status": "NEW",
  • "contactInformation": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Role

Create role

Create Role

Creates a new custom role within the specified organization. Roles define permission sets that can be assigned to organization members, controlling their access to various features and resources.

Permission required: organizationMembers: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Role data to create

description
required
string
followerAssessments
required
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
followerOrganizations
required
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
followingAlerts
required
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
followingAssessments
required
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
followingOrganizations
required
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
followingOrganizationsTags
Array of strings
followingQuestionnaires
required
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
landingPage
required
string (role.RoleLandingPage)
Enum: "ORGANIZATION_DASHBOARD" "ORGANIZATION_MEMBERS" "ORGANIZATION_SETTINGS" "FOLLOWING_DASHBOARD" "FOLLOWERS_DASHBOARD"
name
required
string
organizationAlerts
required
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
organizationMembers
required
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
organizationScanTargets
required
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
organizationScanTargetsTags
Array of strings
organizationSettings
required
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "landingPage": "ORGANIZATION_DASHBOARD",
  • "organizationSettings": "FULL_ACCESS",
  • "organizationMembers": "FULL_ACCESS",
  • "organizationAlerts": "FULL_ACCESS",
  • "organizationScanTargets": "FULL_ACCESS",
  • "organizationScanTargetsTags": [
    ],
  • "followingAlerts": "FULL_ACCESS",
  • "followingQuestionnaires": "FULL_ACCESS",
  • "followingAssessments": "FULL_ACCESS",
  • "followingOrganizations": "FULL_ACCESS",
  • "followingOrganizationsTags": [
    ],
  • "followerAssessments": "FULL_ACCESS",
  • "followerOrganizations": "FULL_ACCESS"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "description": "string",
  • "landingPage": "ORGANIZATION_DASHBOARD",
  • "organizationSettings": "FULL_ACCESS",
  • "organizationMembers": "FULL_ACCESS",
  • "organizationAlerts": "FULL_ACCESS",
  • "organizationScanTargets": "FULL_ACCESS",
  • "organizationScanTargetsTags": [
    ],
  • "followingAlerts": "FULL_ACCESS",
  • "followingQuestionnaires": "FULL_ACCESS",
  • "followingAssessments": "FULL_ACCESS",
  • "followingOrganizations": "FULL_ACCESS",
  • "followingOrganizationsTags": [
    ],
  • "followerAssessments": "FULL_ACCESS",
  • "followerOrganizations": "FULL_ACCESS"
}

Delete role

Delete Role

Permanently removes a custom role from the organization. This action cannot be undone. Members assigned to this role will lose the associated permissions.

Permission required: organizationMembers: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

roleId
required
string <uuid> (common.Id)

Role unique identifier

Responses

Request samples 

curl --request DELETE \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/roles/{roleId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "description": "string",
  • "landingPage": "ORGANIZATION_DASHBOARD",
  • "organizationSettings": "FULL_ACCESS",
  • "organizationMembers": "FULL_ACCESS",
  • "organizationAlerts": "FULL_ACCESS",
  • "organizationScanTargets": "FULL_ACCESS",
  • "organizationScanTargetsTags": [
    ],
  • "followingAlerts": "FULL_ACCESS",
  • "followingQuestionnaires": "FULL_ACCESS",
  • "followingAssessments": "FULL_ACCESS",
  • "followingOrganizations": "FULL_ACCESS",
  • "followingOrganizationsTags": [
    ],
  • "followerAssessments": "FULL_ACCESS",
  • "followerOrganizations": "FULL_ACCESS"
}

Get role

Get Role

Retrieves detailed information about a specific organization role, including its permissions, settings, and configuration.

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

roleId
required
string <uuid> (common.Id)

Role unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/roles/{roleId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "description": "string",
  • "landingPage": "ORGANIZATION_DASHBOARD",
  • "organizationSettings": "FULL_ACCESS",
  • "organizationMembers": "FULL_ACCESS",
  • "organizationAlerts": "FULL_ACCESS",
  • "organizationScanTargets": "FULL_ACCESS",
  • "organizationScanTargetsTags": [
    ],
  • "followingAlerts": "FULL_ACCESS",
  • "followingQuestionnaires": "FULL_ACCESS",
  • "followingAssessments": "FULL_ACCESS",
  • "followingOrganizations": "FULL_ACCESS",
  • "followingOrganizationsTags": [
    ],
  • "followerAssessments": "FULL_ACCESS",
  • "followerOrganizations": "FULL_ACCESS"
}

List roles

List Roles

Retrieves all custom roles available within the specified organization. This includes both built-in and custom-created roles.

Permission required: organizationMembers: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/roles \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • {
    }
]

Update role

Update Role

Modifies an existing organization role's settings, permissions, and properties. Changes will affect all members currently assigned to this role.

Permission required: organizationMembers: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

roleId
required
string <uuid> (common.Id)

Role unique identifier

Request Body schema: application/json
required

Role data to update

description
string
followerAssessments
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
followerOrganizations
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
followingAlerts
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
followingAssessments
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
followingOrganizations
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
followingOrganizationsTags
Array of strings
followingQuestionnaires
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
landingPage
string (role.RoleLandingPage)
Enum: "ORGANIZATION_DASHBOARD" "ORGANIZATION_MEMBERS" "ORGANIZATION_SETTINGS" "FOLLOWING_DASHBOARD" "FOLLOWERS_DASHBOARD"
name
string
organizationAlerts
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
organizationMembers
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
organizationScanTargets
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"
organizationScanTargetsTags
Array of strings
organizationSettings
string (role.RolePermission)
Enum: "FULL_ACCESS" "READ_ONLY" "NO_ACCESS"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "landingPage": "ORGANIZATION_DASHBOARD",
  • "organizationSettings": "FULL_ACCESS",
  • "organizationMembers": "FULL_ACCESS",
  • "organizationAlerts": "FULL_ACCESS",
  • "organizationScanTargets": "FULL_ACCESS",
  • "organizationScanTargetsTags": [
    ],
  • "followingAlerts": "FULL_ACCESS",
  • "followingQuestionnaires": "FULL_ACCESS",
  • "followingAssessments": "FULL_ACCESS",
  • "followingOrganizations": "FULL_ACCESS",
  • "followingOrganizationsTags": [
    ],
  • "followerAssessments": "FULL_ACCESS",
  • "followerOrganizations": "FULL_ACCESS"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "description": "string",
  • "landingPage": "ORGANIZATION_DASHBOARD",
  • "organizationSettings": "FULL_ACCESS",
  • "organizationMembers": "FULL_ACCESS",
  • "organizationAlerts": "FULL_ACCESS",
  • "organizationScanTargets": "FULL_ACCESS",
  • "organizationScanTargetsTags": [
    ],
  • "followingAlerts": "FULL_ACCESS",
  • "followingQuestionnaires": "FULL_ACCESS",
  • "followingAssessments": "FULL_ACCESS",
  • "followingOrganizations": "FULL_ACCESS",
  • "followingOrganizationsTags": [
    ],
  • "followerAssessments": "FULL_ACCESS",
  • "followerOrganizations": "FULL_ACCESS"
}

ScanTarget

Create scan target

Create scan target

Permission required: organizationScanTargets: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Scan target data

object

DEPRECATED (replace by metadata) - Credentials

property name*
additional property
string
groupId
string <uuid>

Scan Target Group unique identifier, which this scan target belongs

kind
required
string
Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"

The type of resource this scan target represents, either a cloud service provider or external attack surface asset

name
required
string

The scan target display name as chosen during onboarding

notification
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"

List of alert severities that should send a notification when occur

object

Configuration specific for the scan target kind, for now handles ASM scan modes

scanMode
required
string (scantarget.ScanTargetDomainScanMode)
Enum: "BACKGROUND" "MANAGED"
object

How frequently this scan target will be scheduled for scanning

frequency
required
string
timeOfDay
required
string
required
share.ShareAll (object) or share.ShareNone (object) or share.ShareFollowers (object)

Scan Target sharing and visibility configuration

Any of
mode
required
string
Value: "ALL"
tags
required
Array of strings (scantarget.ScanTargetTag)

List of identification tags added to this scan target, can be used for specific sharing modes

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "kind": "AWS",
  • "options": {
    },
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "schedule": {
    },
  • "credential": { },
  • "notification": [
    ],
  • "share": {
    },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "kind": "AWS",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "account": "string",
  • "schedule": {
    },
  • "credential": { },
  • "status": "NEW",
  • "notification": [
    ],
  • "lastScan": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "currentScanSlot": "2019-08-24T14:15:22Z",
  • "lastScanSlot": "2019-08-24T14:15:22Z",
  • "share": {
    },
  • "tags": [
    ]
}

Delete scan target

Delete scan target

Permission required: organizationScanTargets: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

scanTargetId
required
string <uuid> (scantarget.ScanTargetId)

Scan target unique identifier

Responses

Request samples 

curl --request DELETE \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/scantargets/{scanTargetId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Get scan target

Get scan target by ID

Permission required: organizationScanTargets: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

scanTargetId
required
string <uuid> (scantarget.ScanTargetId)

Scan target unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/scantargets/{scanTargetId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "kind": "AWS",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "account": "string",
  • "schedule": {
    },
  • "credential": { },
  • "status": "NEW",
  • "notification": [
    ],
  • "lastScan": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "currentScanSlot": "2019-08-24T14:15:22Z",
  • "lastScanSlot": "2019-08-24T14:15:22Z",
  • "share": {
    },
  • "tags": [
    ]
}

Get scan target tags

Get scan target tags

Permission required: organizationScanTargets: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/scantargets/tags \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • "string"
]

List scan targets

Get all scan targets

Permission required: organizationScanTargets: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/scantargets \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • {
    }
]

Update scan target

Update scan target

Permission required: organizationScanTargets: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

scanTargetId
required
string <uuid> (scantarget.ScanTargetId)

Scan target unique identifier

Request Body schema: application/json
required

Updated scan target data

account
string

DEPRECATED (will be on metadata) - The main identifier of the resource this scan target represents, such as an AWS account ID, Azure tenant ID, GCP project name or DNS domain; the format will depend on which kind of scan target this is

object

DEPRECATED (replace by metadata) - Credentials

property name*
additional property
string
groupId
string <uuid>

Scan Target Group unique identifier, which this scan target belongs

name
string

The scan target display name as chosen during onboarding

notification
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"

List of alert severities that should send a notification when occur

object

Configuration specific for the scan target kind, for now handles ASM scan modes

scanMode
required
string (scantarget.ScanTargetDomainScanMode)
Enum: "BACKGROUND" "MANAGED"
object

How frequently this scan target will be scheduled for scanning

frequency
required
string
timeOfDay
required
string
share.ShareAll (object) or share.ShareNone (object) or share.ShareFollowers (object)

Scan Target sharing and visibility configuration

Any of
mode
required
string
Value: "ALL"
status
string
Enum: "NEW" "ACTIVE" "SUSPENDED" "RUNNING" "ERROR" "INVALID_CREDENTIAL"

The current status of the scan target

tags
Array of strings (scantarget.ScanTargetTag)

List of identification tags added to this scan target, can be used for specific sharing modes

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "options": {
    },
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "account": "string",
  • "schedule": {
    },
  • "credential": { },
  • "status": "NEW",
  • "notification": [
    ],
  • "share": {
    },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "name": "string",
  • "kind": "AWS",
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "account": "string",
  • "schedule": {
    },
  • "credential": { },
  • "status": "NEW",
  • "notification": [
    ],
  • "lastScan": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "currentScanSlot": "2019-08-24T14:15:22Z",
  • "lastScanSlot": "2019-08-24T14:15:22Z",
  • "share": {
    },
  • "tags": [
    ]
}

ScanTargetGroup

Create scan target group

Create scan target group

Permission required: organizationScanTargets: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Scan target group data

object (scantarget.ScanTargetGroupCredential)
property name*
additional property
string
kind
required
string (scantarget.ScanTargetGroupKind)
Enum: "ORACLE" "BITBUCKET" "GITLAB" "MONGODB_ATLAS" "CLOUDFLARE" "IBM_CLOUD"
name
required
string
notification
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
object (scantarget.ScanTargetSchedule)
frequency
required
string
timeOfDay
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "kind": "ORACLE",
  • "credential": { },
  • "schedule": {
    },
  • "notification": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "kind": "ORACLE",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "schedule": {
    },
  • "notification": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Create scan targets by compartments

Create scan targets by compartments in a group

Permission required: organizationScanTargets: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
groupId
required
string <uuid> (scantarget.ScanTargetGroupId)

Scan target group unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Scan targets creation data

required
Array of scantarget.BitbucketTarget (object) or scantarget.OracleTarget (object) or scantarget.GitlabTarget (object) or scantarget.MongoDBAtlasTarget (object) or scantarget.CloudflareTarget (object) or scantarget.IbmCloudTarget (object)
Array
Any of
required
share.ShareAll (object) or share.ShareNone (object) or share.ShareFollowers (object)
tags
required
Array of strings (scantarget.ScanTargetTag)
workspaceId
required
string
workspaceName
required
string

Responses

Request samples

Content type
application/json
{
  • "scanTargets": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete scan target group

Delete scan target group

Permission required: organizationScanTargets: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
groupId
required
string <uuid> (scantarget.ScanTargetGroupId)

Scan target group unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
deleteScanTargets
boolean

Whether to delete associated scan targets

Responses

Request samples 

curl --request DELETE \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/scantargetgroups/{groupId}?deleteScanTargets=SOME_BOOLEAN_VALUE' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Get scan target group

Get scan target group by ID

Permission required: organizationScanTargets: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
groupId
required
string <uuid> (scantarget.ScanTargetGroupId)

Scan target group unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/scantargetgroups/{groupId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "kind": "ORACLE",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "schedule": {
    },
  • "notification": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get scan target group script

Get scan target group script

Permission required: organizationScanTargets: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
groupId
required
string <uuid> (scantarget.ScanTargetGroupId)

Scan target group unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/scantargetgroups/{groupId}/scripts \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "script": "string"
}

List scan target compartments by kind

List scan target compartments by kind in a group

Permission required: organizationScanTargets: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
groupId
required
string <uuid> (scantarget.ScanTargetGroupId)

Scan target group unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/scantargetgroups/{groupId}/targets \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • { }
]

List scan target groups

Get all scan target groups

Permission required: organizationScanTargets: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/scantargetgroups \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • {
    }
]

List scan targets in group

Get all scan targets in a group

Permission required: organizationScanTargets: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
groupId
required
string <uuid> (scantarget.ScanTargetGroupId)

Scan target group unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/scantargetgroups/{groupId}/scantargets \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
[
  • {
    }
]

Sign scan target group

Sign scan target group

Permission required: organizationScanTargets: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
groupId
required
string <uuid> (scantarget.ScanTargetGroupId)

Scan target group unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Signing data

required
object (scantarget.ScanTargetGroupCredential)
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "credential": { }
}

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Update scan target group

Update scan target group

Permission required: organizationScanTargets: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
groupId
required
string <uuid> (scantarget.ScanTargetGroupId)

Scan target group unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Updated scan target group data

name
required
string
notification
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
object (scantarget.ScanTargetSchedule)
frequency
required
string
timeOfDay
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "schedule": {
    },
  • "notification": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "kind": "ORACLE",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "schedule": {
    },
  • "notification": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update scan target group credential

Update scan target group credential

Permission required: organizationScanTargets: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
groupId
required
string <uuid> (scantarget.ScanTargetGroupId)

Scan target group unique identifier

organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Credential data

required
object (scantarget.ScanTargetGroupCredential)
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "credential": { }
}

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Summary

Summarizes compliance details

Get compliance detail summary

Permission required: organizationScanTargets: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Filter criteria for compliance detail summary

required
object (summary.Compliance)
id
required
string
version
required
string
includeEmptyScanTargetTags
boolean (common.IncludeEmptyScanTargetTags)

(Optional) Return objects without any ScanTarget tags.

scanTargetIds
Array of strings <uuid> (scantarget.ScanTargetId) [ items <uuid > ]
scanTargetTags
Array of strings (scantarget.ScanTargetTag)
severities
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"

Responses

Request samples

Content type
application/json
{
  • "compliance": {
    },
  • "scanTargetTags": [
    ],
  • "scanTargetIds": [
    ],
  • "severities": [
    ],
  • "includeEmptyScanTargetTags": true
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Summarizes compliance overtime

Get compliance overtime summary

Permission required: organizationScanTargets: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Filter criteria for compliance overtime summary

required
object (summary.Compliance)
id
required
string
version
required
string
dates
required
Array of strings (common.UTCDate)
includeEmptyScanTargetTags
boolean (common.IncludeEmptyScanTargetTags)

(Optional) Return objects without any ScanTarget tags.

scanTargetIds
Array of strings <uuid> (scantarget.ScanTargetId) [ items <uuid > ]
scanTargetTags
Array of strings (scantarget.ScanTargetTag)
severities
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"

Responses

Request samples

Content type
application/json
{
  • "compliance": {
    },
  • "dates": [
    ],
  • "scanTargetTags": [
    ],
  • "scanTargetIds": [
    ],
  • "severities": [
    ],
  • "includeEmptyScanTargetTags": true
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Summarizes following compliance details

Get compliance detail summary for followed organizations

Permission required: followingAlerts: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Filter criteria for following compliance detail summary

required
object (summary.Compliance)
id
required
string
version
required
string
followingIds
Array of strings <uuid> (organization.OrganizationId) [ items <uuid > ]
followingTags
Array of strings (follow.FollowTag)
includeEmptyFollowingTags
boolean (common.IncludeEmptyFollowingTags)

(Optional) Return objects without any Following tags.

severities
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"

Responses

Request samples

Content type
application/json
{
  • "compliance": {
    },
  • "followingIds": [
    ],
  • "followingTags": [
    ],
  • "severities": [
    ],
  • "includeEmptyFollowingTags": true
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Summarizes following compliance overtime

Get compliance overtime summary for followed organizations

Permission required: followingAlerts: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Filter criteria for following compliance overtime summary

required
object (summary.Compliance)
id
required
string
version
required
string
dates
required
Array of strings (common.UTCDate)
followingIds
Array of strings <uuid> (organization.OrganizationId) [ items <uuid > ]
followingTags
Array of strings (follow.FollowTag)
includeEmptyFollowingTags
boolean (common.IncludeEmptyFollowingTags)

(Optional) Return objects without any Following tags.

severities
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"

Responses

Request samples

Content type
application/json
{
  • "compliance": {
    },
  • "dates": [
    ],
  • "followingTags": [
    ],
  • "followingIds": [
    ],
  • "severities": [
    ],
  • "includeEmptyFollowingTags": true
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Summarizes following scantarget details

Get scan target detail summary for followed organizations

Permission required: followingOrganizations: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Filter criteria for scan target detail summary

alertSeverities
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
followingIds
Array of strings <uuid> (organization.OrganizationId) [ items <uuid > ]
followingTags
Array of strings (follow.FollowTag)
includeEmptyFollowingTags
boolean
scanTargetKinds
Array of strings (scantarget.ScanTargetKind)
Items Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"

Responses

Request samples

Content type
application/json
{
  • "followingIds": [
    ],
  • "followingTags": [
    ],
  • "scanTargetKinds": [
    ],
  • "alertSeverities": [
    ],
  • "includeEmptyFollowingTags": true
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Summarizes following scantarget overtime

Get scan target overtime summary for followed organizations

Permission required: followingOrganizations: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Filter criteria for scan target overtime summary

alertSeverities
Array of strings (alert.AlertSeverity)
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
dates
required
Array of strings (common.UTCDate)
followingIds
Array of strings <uuid> (organization.OrganizationId) [ items <uuid > ]
followingTags
Array of strings (follow.FollowTag)
includeEmptyFollowingTags
boolean
scanTargetKinds
Array of strings (scantarget.ScanTargetKind)
Items Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"

Responses

Request samples

Content type
application/json
{
  • "dates": [
    ],
  • "followingIds": [
    ],
  • "followingTags": [
    ],
  • "scanTargetKinds": [
    ],
  • "alertSeverities": [
    ],
  • "includeEmptyFollowingTags": true
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Summarizes following score details

Get score detail summary for followed organizations

Permission required: followingOrganizations: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Filter criteria for following score detail summary

followerId
string <uuid> (organization.OrganizationId)
followingIds
Array of strings <uuid> (organization.OrganizationId) [ items <uuid > ]
followingTags
Array of strings (follow.FollowTag)

Responses

Request samples

Content type
application/json
{
  • "followingIds": [
    ],
  • "followingTags": [
    ],
  • "followerId": "62213f7a-f0bf-47a0-a6dd-74e2885412b0"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Summarizes following score overtime

Get score overtime summary for followed organizations

Permission required: followingOrganizations: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Filter criteria for following score overtime summary

dates
required
Array of strings (common.UTCDate)
followerId
string <uuid> (organization.OrganizationId)
followingIds
Array of strings <uuid> (organization.OrganizationId) [ items <uuid > ]
followingTags
Array of strings (follow.FollowTag)

Responses

Request samples

Content type
application/json
{
  • "dates": [
    ],
  • "followingIds": [
    ],
  • "followingTags": [
    ],
  • "followerId": "62213f7a-f0bf-47a0-a6dd-74e2885412b0"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Summarizes scantarget detail

Get scan target detail summary

Permission required: organizationScanTargets: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Filter criteria for scan target detail summary

alertSeverities
Array of strings (alert.AlertSeverity) non-empty
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
includeEmptyScanTargetTags
boolean
scanTargetIds
Array of strings <uuid> (scantarget.ScanTargetId) [ 1 .. 10 ] items [ items <uuid > ]
scanTargetKinds
Array of strings (scantarget.ScanTargetKind) non-empty
Items Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"
scanTargetTags
Array of strings (scantarget.ScanTargetTag) non-empty

Responses

Request samples

Content type
application/json
{
  • "scanTargetIds": [
    ],
  • "scanTargetTags": [
    ],
  • "scanTargetKinds": [
    ],
  • "alertSeverities": [
    ],
  • "includeEmptyScanTargetTags": true
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Summarizes scantarget overtime

Get scan target overtime summary

Permission required: organizationScanTargets: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Filter criteria for scan target overtime summary

alertSeverities
Array of strings (alert.AlertSeverity) non-empty
Items Enum: "CRITICAL" "HIGH" "MEDIUM" "LOW" "INFO"
dates
required
Array of strings (common.UTCDate)
includeEmptyScanTargetTags
boolean
scanTargetIds
Array of strings <uuid> (scantarget.ScanTargetId) [ 1 .. 10 ] items [ items <uuid > ]
scanTargetKinds
Array of strings (scantarget.ScanTargetKind) non-empty
Items Enum: "AWS" "AZURE" "BITBUCKET" "DOMAIN" "GCP" "GITHUB" "GITLAB" "GWORKSPACE" "HUAWEI" "JIRA" "MONGODB_ATLAS" "MS365" "ORACLE" "SALESFORCE" "SLACK" "ZENDESK" "CLOUDFLARE" "CROWDSTRIKE_FALCON" "BITDEFENDER" "SENTINEL_ONE"
scanTargetTags
Array of strings (scantarget.ScanTargetTag) non-empty

Responses

Request samples

Content type
application/json
{
  • "dates": [
    ],
  • "scanTargetIds": [
    ],
  • "scanTargetTags": [
    ],
  • "scanTargetKinds": [
    ],
  • "alertSeverities": [
    ],
  • "includeEmptyScanTargetTags": true
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Summarizes score details

Get score detail summary

Permission required: organizationSettings: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Filter criteria for score detail summary

object (summary.ScoreDetailSummaryFilter)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Summarizes score overtime

Get score overtime summary

Permission required: organizationSettings: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Filter criteria for score overtime summary

dates
required
Array of strings (common.UTCDate)

Responses

Request samples

Content type
application/json
{
  • "dates": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Webhook

Webhook Operations

Create webhook

Create Webhook

Permission required: organizationSettings: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

Request Body schema: application/json
required

Webhook Data to create

webhook.WebhookAuthorizationBasic (object) or webhook.WebhookAuthorizationApiKey (object) or webhook.WebhookAuthorizationNone (object)

The authorization configuration for the webhook

Any of
password
required
string

Basic auth password

type
required
string
Value: "BASIC"
username
required
string

Basic auth username

description
required
string

The webhook description

required
Array of alert.AlertEventName (string) or alert.AlertCommentEventName (string) or questionnaire.AnswerEventName (string) or questionnaire.AssessmentEventName (string) or questionnaire.AssessmentCommentEventName (string) or follow.FollowerEventName (string) or follow.FollowingEventName (string) or member.MemberEventName (string) or organization.OrganizationEventName (string) or questionnaire.QuestionEventName (string) or questionnaire.QuestionnaireEventName (string) or scan.ScanEventName (string) or scantarget.ScanTargetEventName (string) or webhook.WebhookEventName (string)

List of events that trigger this webhook

Array
Any of
string (alert.AlertEventName)
Enum: "AlertCreated" "AlertUpdated" "AlertFollowingCreated" "AlertFollowingUpdated"
name
required
string

The webhook name

url
required
string

The webhook URL endpoint

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "organizationId": "00000000-0000-4000-a000-000000000001",
  • "id": "00000000-0000-4000-a000-000000000002",
  • "name": "Security Alerts Webhook",
  • "description": "Webhook for receiving security alerts and notifications",
  • "url": "https://example.com/webhooks/security-alerts",
  • "authorizationType": "API_KEY",
  • "events": [
    ],
  • "status": "ACTIVE",
  • "metadata": {
    },
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "updatedAt": "2023-01-15T10:30:00.000Z"
}

Delete webhook

Delete Webhook

Permission required: organizationSettings: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

webhookId
required
string <uuid> (webhook.WebhookId)

Webhook unique identifier

Responses

Request samples 

curl --request DELETE \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/webhooks/{webhookId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Get webhook

Get Webhook

Permission required: organizationSettings: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

webhookId
required
string <uuid> (webhook.WebhookId)

Webhook unique identifier

Responses

Request samples 

curl --request GET \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/webhooks/{webhookId} \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "organizationId": "00000000-0000-4000-a000-000000000001",
  • "id": "00000000-0000-4000-a000-000000000002",
  • "name": "Security Alerts Webhook",
  • "description": "Webhook for receiving security alerts and notifications",
  • "url": "https://example.com/webhooks/security-alerts",
  • "authorizationType": "API_KEY",
  • "events": [
    ],
  • "status": "ACTIVE",
  • "metadata": {
    },
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "updatedAt": "2023-01-15T10:30:00.000Z"
}

Get webhook metrics

An endpoint to get the usage metrics of a specific webhook.

Permission required: organizationSettings: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

webhookId
required
string <uuid> (webhook.WebhookId)

Webhook unique identifier

Responses

Request samples 

curl --request POST \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/webhooks/{webhookId}/metrics \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "invocations": {
    },
  • "failedInvocations": {
    }
}

List webhooks

List Webhooks

Permission required: organizationSettings: READ_ONLY

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

query Parameters
cursor
string
size
integer <uint16> [ 1 .. 1000 ]
Default: 25

Responses

Request samples 

curl --request GET \
  --url 'https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/webhooks?size={INTEGER}&cursor={STRING}' \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "cursor": "string"
}

Ping webhook

Send a ping event to test the webhook.

Permission required: organizationSettings: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

webhookId
required
string <uuid> (webhook.WebhookId)

Webhook unique identifier

Responses

Request samples 

curl --request POST \
  --url https://api.zanshin.tenchisecurity.com/organizations/{organizationId}/webhooks/{webhookId}/ping \
  --header 'Authorization: Bearer {TOKEN}'

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "message": "BadRequest"
}

Update webhook

Update Webhook

Permission required: organizationSettings: FULL_ACCESS

Authorizations:
ZanshinAuth
path Parameters
organizationId
required
string <uuid> (organization.OrganizationId)

Organization unique identifier

webhookId
required
string <uuid> (webhook.WebhookId)

Webhook unique identifier

Request Body schema: application/json
required

Webhook Data to update

webhook.WebhookAuthorizationBasic (object) or webhook.WebhookAuthorizationApiKey (object) or webhook.WebhookAuthorizationNone (object)

The authorization configuration for the webhook

Any of
password
required
string

Basic auth password

type
required
string
Value: "BASIC"
username
required
string

Basic auth username

description
string

The webhook description

Array of alert.AlertEventName (string) or alert.AlertCommentEventName (string) or questionnaire.AnswerEventName (string) or questionnaire.AssessmentEventName (string) or questionnaire.AssessmentCommentEventName (string) or follow.FollowerEventName (string) or follow.FollowingEventName (string) or member.MemberEventName (string) or organization.OrganizationEventName (string) or questionnaire.QuestionEventName (string) or questionnaire.QuestionnaireEventName (string) or scan.ScanEventName (string) or scantarget.ScanTargetEventName (string) or webhook.WebhookEventName (string)

List of events that trigger this webhook

Array
Any of
string (alert.AlertEventName)
Enum: "AlertCreated" "AlertUpdated" "AlertFollowingCreated" "AlertFollowingUpdated"
name
string

The webhook name

url
string

The webhook URL endpoint

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "organizationId": "00000000-0000-4000-a000-000000000001",
  • "id": "00000000-0000-4000-a000-000000000002",
  • "name": "Security Alerts Webhook",
  • "description": "Webhook for receiving security alerts and notifications",
  • "url": "https://example.com/webhooks/security-alerts",
  • "authorizationType": "API_KEY",
  • "events": [
    ],
  • "status": "ACTIVE",
  • "metadata": {
    },
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "updatedAt": "2023-01-15T10:30:00.000Z"
}