threatModelArtifacts

Returns threat model artifacts by company

threatModelArtifacts(
  companyId: ID!
  pagination: BasePaginationInput! = [object Object]
  search: String
  assigneeEmail: String
  hasVersion: Boolean
): ThreatModelArtifactCollection!

Arguments

threatModelArtifacts.companyId ● ID! non-null scalar

threatModelArtifacts.pagination ● BasePaginationInput! non-null input

threatModelArtifacts.search ● String scalar

threatModelArtifacts.assigneeEmail ● String scalar

threatModelArtifacts.hasVersion ● Boolean scalar

Type

ThreatModelArtifactCollection object

ThreatModelArtifactCollection type

Example request

This generated query uses placeholders for required values. Replace them with values available to your API key before running it.

Before you run it

Run the companies query first and use data.companies.collection[].id as companyId.

cURL

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"query GetThreatModelArtifacts($companyId: ID!) {\n  threatModelArtifacts(companyId: $companyId) { collection { id label assignee { __typename } } metadata { currentPage limitValue totalCount } }\n}","variables":{"companyId":"<company_id>"}}'

JavaScript

const response = await fetch('https://api.convisoappsec.com/graphql', {
  method: 'POST',
  headers: {
    'content-type': 'application/json',
    'x-api-key': process.env.CONVISO_API_KEY,
  },
  body: JSON.stringify({
    query: "query GetThreatModelArtifacts($companyId: ID!) {\n  threatModelArtifacts(companyId: $companyId) { collection { id label assignee { __typename } } metadata { currentPage limitValue totalCount } }\n}",
    variables: {
    "companyId": "<company_id>"
},
  }),
});

const { data, errors } = await response.json();

if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);

Python

import json
import os
import requests

response = requests.post(
    'https://api.convisoappsec.com/graphql',
    headers={
        'content-type': 'application/json',
        'x-api-key': os.environ['CONVISO_API_KEY'],
    },
    json={
        'query': "query GetThreatModelArtifacts($companyId: ID!) {\n  threatModelArtifacts(companyId: $companyId) { collection { id label assignee { __typename } } metadata { currentPage limitValue totalCount } }\n}",
        'variables': json.loads("{\"companyId\":\"<company_id>\"}"),
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
if payload.get('errors'):
    raise RuntimeError(payload['errors'])

print(payload['data'])