From cb4f64b9286102ac3e93f2c9cefec042fb53b0c8 Mon Sep 17 00:00:00 2001 From: Veronica Cernea Date: Thu, 30 May 2024 13:59:15 +0000 Subject: [PATCH 01/12] GITBOOK-7215: vc-Ruby: fix callout --- docs/getting-started/supported-languages-and-frameworks/ruby.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/supported-languages-and-frameworks/ruby.md b/docs/getting-started/supported-languages-and-frameworks/ruby.md index 090052d6d6fa..405aac9b10ff 100644 --- a/docs/getting-started/supported-languages-and-frameworks/ruby.md +++ b/docs/getting-started/supported-languages-and-frameworks/ruby.md @@ -119,7 +119,7 @@ When creating Fix PRs for Ruby Projects using private Gem sources, Snyk may need ### Snyk Web UI (Git repository integration) -Snyk for Ruby is not available at the moment for Snyk Web UI. You can use it with the [CLI,](ruby.md#snyk-cli) or with the available [Snyk integrations](ruby.md#snyk-integrations). +You can test your Ruby projects using the Snyk Web UI. ### Snyk integrations From af6591fd6b5b385fcc24e1febd8086c0bea1b152 Mon Sep 17 00:00:00 2001 From: Ann Wiley Date: Thu, 30 May 2024 15:21:13 +0000 Subject: [PATCH 02/12] GITBOOK-7216: Lang: Angular, remove partial support, main page and Javascript pages --- docs/README.md | 2 +- docs/SUMMARY.md | 6 +- docs/enterprise-configuration/README.md | 2 +- docs/getting-started/README.md | 2 +- docs/getting-started/quickstart/README.md | 2 +- docs/getting-started/snyk-release-process.md | 2 +- .../.net/README.md | 8 +-- .../.net/best-practices-for-.net.md | 10 +-- .../.net/improved-.net-scanning.md | 0 .../README.md | 62 +++++++++---------- .../best-practices-for-java-and-kotlin.md | 2 +- .../javascript/README.md | 2 +- ...st-practices-for-javascript-and-node.js.md | 2 +- .../technical-specifications.md | 4 +- ...snyk-azure-repositories-tfs-integration.md | 2 +- ...nguage-support-for-teamcity-integration.md | 2 +- .../user-defined-custom-images-for-cli.md | 2 +- .../configure-pull-request-checks.md | 2 +- docs/scan-with-snyk/snyk-code/README.md | 4 +- .../snyk-code/configure-snyk-code.md | 2 +- .../manage-code-vulnerabilities/README.md | 4 +- ...upported-operating-system-distributions.md | 4 +- .../README.md | 2 +- .../scan-with-snyk/snyk-open-source/README.md | 2 +- ...g-vulnerabilities-with-snyk-open-source.md | 2 +- .../group-and-organization-settings.md | 2 +- .../snyk-cli-for-open-source/README.md | 6 +- .../snyk-cli-for-snyk-code/README.md | 2 +- 28 files changed, 72 insertions(+), 72 deletions(-) rename docs/{scan-with-snyk => getting-started}/supported-languages-and-frameworks/.net/README.md (95%) rename docs/getting-started/{supported-languages-frameworks-and-feature-availability-overview => supported-languages-and-frameworks}/.net/improved-.net-scanning.md (100%) rename docs/{scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview => getting-started/supported-languages-and-frameworks}/README.md (77%) diff --git a/docs/README.md b/docs/README.md index e157c9e3f517..e534cfbf31db 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ ## Start using Snyk -
​Getting started
Start running Snyk to secure your code		Enterprise configuration
Use Snyk in an enterprise system		Implement Snyk
Set up Snyk to run in your business		Supported languages
Match your language and framework to Snyk
+
​Getting started
Start running Snyk to secure your code		Enterprise configuration
Use Snyk in an enterprise system		Implement Snyk
Set up Snyk to run in your business		Supported languages
Match your language and framework to Snyk
## Integrate with Snyk diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 79462717829c..ec5739e4dc1e 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -7,10 +7,10 @@ * [Set up an integration](getting-started/quickstart/set-up-an-integration.md) * [Import a Project](getting-started/quickstart/import-a-project.md) * [View Snyk scan results](getting-started/quickstart/view-snyk-scan-results.md) - * [Supported languages and frameworks](scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/README.md) + * [Supported languages and frameworks](getting-started/supported-languages-and-frameworks/README.md) * [Technical specifications](getting-started/supported-languages-and-frameworks/technical-specifications.md) - * [.NET](scan-with-snyk/supported-languages-and-frameworks/.net/README.md) - * [Improved .NET scanning](getting-started/supported-languages-frameworks-and-feature-availability-overview/.net/improved-.net-scanning.md) + * [.NET](getting-started/supported-languages-and-frameworks/.net/README.md) + * [Improved .NET scanning](getting-started/supported-languages-and-frameworks/.net/improved-.net-scanning.md) * [Best practices for .NET](getting-started/supported-languages-and-frameworks/.net/best-practices-for-.net.md) * [Troubleshooting .NET](getting-started/supported-languages-and-frameworks/.net/troubleshooting-.net.md) * [Apex](getting-started/supported-languages-and-frameworks/apex.md) diff --git a/docs/enterprise-configuration/README.md b/docs/enterprise-configuration/README.md index 5c5932547da3..8f3a099c035d 100644 --- a/docs/enterprise-configuration/README.md +++ b/docs/enterprise-configuration/README.md @@ -22,7 +22,7 @@ Snyk has a number of tools and processes that help secure your entire software d For users who are evaluating Snyk or planning an enterprise deployment, and for most programming languages, Snyk recommends integrating with a Git repository to get started. {% hint style="info" %} -The tool that best serves your tech stack, environment, and workflow depends on your individual circumstances. See [Supported languages and frameworks ](../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/)for the guide specific to your language for more details. +The tool that best serves your tech stack, environment, and workflow depends on your individual circumstances. See [Supported languages and frameworks ](../getting-started/supported-languages-and-frameworks/)for the guide specific to your language for more details. {% endhint %} To learn more about choosing the best integration points within the software development lifecycle for you and for your team, at their current level of security maturity, see [Integrating Snyk at your company](https://learn.snyk.io/lesson/integrate-snyk-at-your-company/). diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index 1f89b166af02..5e93ebb2b060 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -39,7 +39,7 @@ Running Snyk from the command line. The Snyk tech stacks that are supported depend on the Snyk product you use: -* **Snyk Open Source** and **Snyk Code**: see [Supported languages and frameworks](../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/). +* **Snyk Open Source** and **Snyk Code**: see [Supported languages and frameworks](supported-languages-and-frameworks/). * **Snyk Container**: see [Supported operating system distributions](../scan-with-snyk/snyk-container/how-snyk-container-works/supported-operating-system-distributions.md). * **Snyk Infrastructure as Code**: see [Supported IaC and cloud providers](../scan-with-snyk/snyk-iac/supported-iac-languages-cloud-providers-and-cloud-resources/). diff --git a/docs/getting-started/quickstart/README.md b/docs/getting-started/quickstart/README.md index 2c84a25423e4..18008e9ce7c5 100644 --- a/docs/getting-started/quickstart/README.md +++ b/docs/getting-started/quickstart/README.md @@ -3,7 +3,7 @@ This quickstart helps you with these basic tasks in the Snyk application: {% hint style="info" %} -Before starting, check that the code in your repositories matches Snyk's [supported languages and frameworks](../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/). +Before starting, check that the code in your repositories matches Snyk's [supported languages and frameworks](../supported-languages-and-frameworks/). {% endhint %} 1. [Create a Snyk account](create-or-log-in-to-a-snyk-account.md). diff --git a/docs/getting-started/snyk-release-process.md b/docs/getting-started/snyk-release-process.md index 2c764993082f..0ca9b35bbe09 100644 --- a/docs/getting-started/snyk-release-process.md +++ b/docs/getting-started/snyk-release-process.md @@ -38,7 +38,7 @@ Not all features follow all these stages, and timelines for each feature to move * [Git repository cloning](../snyk-admin/snyk-preview.md#enable-git-repository-cloning) * [Fix code vulnerabilities automatically](../scan-with-snyk/snyk-code/manage-code-vulnerabilities/fix-code-vulnerabilities-automatically.md) * [Snyk broker commit signing](../enterprise-configuration/snyk-broker/snyk-broker-commit-signing.md) -* [Improved .NET scanning](supported-languages-frameworks-and-feature-availability-overview/.net/improved-.net-scanning.md) +* [Improved .NET scanning](supported-languages-and-frameworks/.net/improved-.net-scanning.md) ## General Availability diff --git a/docs/scan-with-snyk/supported-languages-and-frameworks/.net/README.md b/docs/getting-started/supported-languages-and-frameworks/.net/README.md similarity index 95% rename from docs/scan-with-snyk/supported-languages-and-frameworks/.net/README.md rename to docs/getting-started/supported-languages-and-frameworks/.net/README.md index befdb1393019..ef91f91653d6 100644 --- a/docs/scan-with-snyk/supported-languages-and-frameworks/.net/README.md +++ b/docs/getting-started/supported-languages-and-frameworks/.net/README.md @@ -3,7 +3,7 @@ ## Supported frameworks and package managers {% hint style="info" %} -Snyk has introduced a new Early Access feature with significantly enhanced scanning capabilities for NuGet applications. For detailed information and access to these features, visit the [Improved .NET scanning](../../../getting-started/supported-languages-frameworks-and-feature-availability-overview/.net/improved-.net-scanning.md) page. +Snyk has introduced a new Early Access feature with significantly enhanced scanning capabilities for NuGet applications. For detailed information and access to these features, visit the [Improved .NET scanning](improved-.net-scanning.md) page. {% endhint %} {% hint style="info" %} @@ -55,7 +55,7 @@ To check compliance for open source licenses, see [Getting Started with Snyk Lic #### Prerequisites -1. [Create a Snyk account](../../../getting-started/quickstart/create-or-log-in-to-a-snyk-account.md) +1. [Create a Snyk account](../../quickstart/create-or-log-in-to-a-snyk-account.md) 2. [Install Snyk CLI and authenticate your machine](../../../snyk-cli/getting-started-with-the-snyk-cli.md#install-the-snyk-cli-and-authenticate-your-machine) 3. [Set the default Organization for all Snyk tests](../../../snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-cli-for-snyk-code/set-the-snyk-organization-for-the-cli-tests.md) (code analysis) @@ -169,7 +169,7 @@ You can also **update your language preferences.** #### Fixing vulnerabilities for .NET -For a general understanding of how Snyk helps you fix Open Source vulnerabilities within your Projects, see [Fix your vulnerabilities](../../snyk-open-source/manage-vulnerabilities/fix-your-vulnerabilities.md). +For a general understanding of how Snyk helps you fix Open Source vulnerabilities within your Projects, see [Fix your vulnerabilities](../../../scan-with-snyk/snyk-open-source/manage-vulnerabilities/fix-your-vulnerabilities.md). {% hint style="info" %} **Feature availability**\ @@ -188,5 +188,5 @@ If you are currently managing your Project dependencies with NuGet and leveragin ## Help -For best practices and troubleshooting, see [Help](../../../getting-started/supported-languages-and-frameworks/.net/best-practices-for-.net.md). +For best practices and troubleshooting, see [Help](best-practices-for-.net.md). diff --git a/docs/getting-started/supported-languages-and-frameworks/.net/best-practices-for-.net.md b/docs/getting-started/supported-languages-and-frameworks/.net/best-practices-for-.net.md index 670288f59204..23ee53f457b8 100644 --- a/docs/getting-started/supported-languages-and-frameworks/.net/best-practices-for-.net.md +++ b/docs/getting-started/supported-languages-and-frameworks/.net/best-practices-for-.net.md @@ -51,13 +51,13 @@ Use this guide to apply Snyk effectively in your technology stack. Snyk Code can analyze your C# code using IDE, CLI, and Git integration. -For framework support, see [Snyk Code - Supported languages and frameworks](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/). +For framework support, see [Snyk Code - Supported languages and frameworks](../). ## Nuget * **Target Frameworks**: Snyk identifies the target frameworks and presents results against each identified version using the git integration. * **Development dependencies**: Snyk generally does not scan developer dependencies, as they are not usually pushed to production and are seen as "noise." \ - Enable visibility in Nuget git import using the **Settings > Languages > .Net** settings (see [Git settings for .NET](../../../scan-with-snyk/supported-languages-and-frameworks/.net/#git-settings-for-.net)). \ + Enable visibility in Nuget git import using the **Settings > Languages > .Net** settings (see [Git settings for .NET](./#git-settings-for-.net)). \ Snyk scans and fixes the build and `development Dependency` sections of your [`*.proj`](#user-content-fn-1)[^1], `packages.config` and `project.json` files * **Lock files**: Currently, **packages-lock.json** is not supported. Snyk interacts with the build system to determine the installed dependencies. * **PackageReference:** Snyk currently requires a version attribute. If your Project lacks this, Snyk may fail to open a PR for your Project. @@ -94,7 +94,7 @@ Runtime dependencies (provided by the runtime environment known as "meta-package Snyk can analyze dependencies managed by Paket through the CLI. Keep in mind that the paket.dependencies and paket.lock must be present. -For more information on Paket support, see [Snyk for .NET](../../../scan-with-snyk/supported-languages-and-frameworks/.net/). +For more information on Paket support, see [Snyk for .NET](./). ## Other @@ -104,7 +104,7 @@ Snyk provides custom test APIs for your unique dependency management strategies. ## Build-time versus runtime dependencies -See [.NET](../../../scan-with-snyk/supported-languages-and-frameworks/.net/) for more information +See [.NET](./) for more information ## Snyk CLI tips and tricks @@ -148,7 +148,7 @@ Use the `snyk code test` command from the root of the Project to perform source The following is a collection of articles from the Snyk Security team and Developer Relations related to this ecosystem. * [Snyk Blog](https://snyk.io/blog/) -* [Snyk for .Net](../../../scan-with-snyk/supported-languages-and-frameworks/.net/) +* [Snyk for .Net](./) * [Best Practices for Containerizing .NET applications](https://snyk.io/blog/best-practices-for-containerizing-net-applications/) diff --git a/docs/getting-started/supported-languages-frameworks-and-feature-availability-overview/.net/improved-.net-scanning.md b/docs/getting-started/supported-languages-and-frameworks/.net/improved-.net-scanning.md similarity index 100% rename from docs/getting-started/supported-languages-frameworks-and-feature-availability-overview/.net/improved-.net-scanning.md rename to docs/getting-started/supported-languages-and-frameworks/.net/improved-.net-scanning.md diff --git a/docs/scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/README.md b/docs/getting-started/supported-languages-and-frameworks/README.md similarity index 77% rename from docs/scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/README.md rename to docs/getting-started/supported-languages-and-frameworks/README.md index 7df4c3f499ba..c51104bd9783 100644 --- a/docs/scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/README.md +++ b/docs/getting-started/supported-languages-and-frameworks/README.md @@ -10,7 +10,7 @@ Here you can find information about the programming languages, fully supported p Before testing your Open Source Project for vulnerabilities, with limited exceptions, you must **build your Project**. For details, see [Open Source Projects that must be built before testing with the Snyk CLI](../../snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-cli-for-open-source/open-source-projects-that-must-be-built-before-testing-with-the-snyk-cli.md). {% endhint %} -### [.NET](../../scan-with-snyk/supported-languages-and-frameworks/.net/) +### [.NET](.net/) **Package manager**: NuGet, Paket @@ -30,7 +30,7 @@ Before testing your Open Source Project for vulnerabilities, with limited except **Package manager versions**: NA -### [C/C++](../../getting-started/supported-languages-and-frameworks/c-c++/) +### [C/C++](c-c++/) **Package manager**: NA @@ -49,7 +49,7 @@ Before testing your Open Source Project for vulnerabilities, with limited except **Package manager versions**: NA -### [Dart and Flutter](../../getting-started/supported-languages-and-frameworks/dart-and-flutter.md) +### [Dart and Flutter](dart-and-flutter.md) **Package manager**: Pub @@ -65,7 +65,7 @@ Before testing your Open Source Project for vulnerabilities, with limited except **Package manager versions**: NA -### [Elixir](../../getting-started/supported-languages-and-frameworks/elixir.md) +### [Elixir](elixir.md) **Package manager**: Hex @@ -84,7 +84,7 @@ Before testing your Open Source Project for vulnerabilities, with limited except **Package manager versions**: NA -### [Go](../../getting-started/supported-languages-and-frameworks/go.md) +### [Go](go.md) **Package manager**: Go Modules, dep @@ -103,7 +103,7 @@ Before testing your Open Source Project for vulnerabilities, with limited except **Package manager versions**: NA -### [Java and Kotlin](../../getting-started/supported-languages-and-frameworks/java-and-kotlin/) +### [Java and Kotlin](java-and-kotlin/) **Package manager**: Maven, Gradle @@ -129,7 +129,7 @@ Before testing your Open Source Project for vulnerabilities, with limited except * `4.*`, `5.*`, `6.*`, `7.*`\ For more information, see the [Snyk Gradle plugin readme](https://github.com/snyk/snyk-gradle-plugin#support). -### [JavaScript](../../getting-started/supported-languages-and-frameworks/javascript/) +### [JavaScript](javascript/) **Package manager**: npm, Yarn @@ -151,11 +151,11 @@ Before testing your Open Source Project for vulnerabilities, with limited except * npm * `Lockfile 1, Lockfile 2, Lockfile 3, 7.*`\ - For details, see the [Snyk Javascript ](../../getting-started/supported-languages-and-frameworks/javascript/#npm)page. + For details, see the [Snyk Javascript ](javascript/#npm)page. * Yarn - * `Yarn 1, Yarn 2, Yarn 3`. For more information, see the [Snyk Javascript ](../../getting-started/supported-languages-and-frameworks/javascript/#yarn)page. + * `Yarn 1, Yarn 2, Yarn 3`. For more information, see the [Snyk Javascript ](javascript/#yarn)page. -### [PHP](../../getting-started/supported-languages-and-frameworks/php.md) +### [PHP](php.md) **Package manager**: Composer @@ -174,7 +174,7 @@ Before testing your Open Source Project for vulnerabilities, with limited except **Package manager versions**: NA -### [Python](../../getting-started/supported-languages-and-frameworks/python.md) +### [Python](python.md) **Package manager**: Pip, Poetry, pipenv, setup.py @@ -194,7 +194,7 @@ Before testing your Open Source Project for vulnerabilities, with limited except **Package manager versions**: Suitable with `Python 2 -> 2.7.16`, and `Python 3 -> 3.7.4`. -### [Ruby](../../getting-started/supported-languages-and-frameworks/ruby.md) +### [Ruby](ruby.md) **Package manager**: Bundler @@ -212,9 +212,9 @@ Before testing your Open Source Project for vulnerabilities, with limited except * License scanning * Reports -**Package manager versions**: All Gemfile and Gemfile.lock are compatible with the [Snyk supported Ruby versions](../../getting-started/supported-languages-and-frameworks/ruby.md#supported-ruby-versions). +**Package manager versions**: All Gemfile and Gemfile.lock are compatible with the [Snyk supported Ruby versions](ruby.md#supported-ruby-versions). -### [Rust](../../getting-started/supported-languages-and-frameworks/rust.md) +### [Rust](rust.md) **Package manager**: Cargo @@ -230,7 +230,7 @@ Before testing your Open Source Project for vulnerabilities, with limited except **Package manager versions**: NA -### [Scala](../../getting-started/supported-languages-and-frameworks/scala.md) +### [Scala](scala.md) **Package manager**: sbt @@ -249,7 +249,7 @@ Before testing your Open Source Project for vulnerabilities, with limited except **Package manager versions**: NA -### [Swift and Objective-C](../../getting-started/supported-languages-and-frameworks/swift-and-objective-c.md) +### [Swift and Objective-C](swift-and-objective-c.md) **Package manager**: CocoaPods, Swift Package Manager @@ -272,7 +272,7 @@ Before testing your Open Source Project for vulnerabilities, with limited except Here you can find information about the programming languages, fully supported frameworks, and features for Snyk Code. -### [Apex](../../getting-started/supported-languages-and-frameworks/apex.md) +### [Apex](apex.md) **Frameworks**: APEX @@ -287,7 +287,7 @@ Here you can find information about the programming languages, fully supported f * Interfile is supported * `.trigger` and `.cls` files are supported -### [.Net](../../scan-with-snyk/supported-languages-and-frameworks/.net/) +### [.Net](.net/) **Frameworks**: @@ -310,7 +310,7 @@ Here you can find information about the programming languages, fully supported f * ASP.NET 6.x * .NET 6 -### [C/C++](../../getting-started/supported-languages-and-frameworks/c-c++/) +### [C/C++](c-c++/) **Frameworks**: C++ Standard Library @@ -320,7 +320,7 @@ Here you can find information about the programming languages, fully supported f **Features**: Reports -### [Go](../../getting-started/supported-languages-and-frameworks/go.md) +### [Go](go.md) **Frameworks**: GORM @@ -335,7 +335,7 @@ Here you can find information about the programming languages, fully supported f **Framework versions**: Versions up to go1.16 -### [Java](../../getting-started/supported-languages-and-frameworks/java-and-kotlin/) +### [Java](java-and-kotlin/) **Frameworks:** @@ -357,7 +357,7 @@ Here you can find information about the programming languages, fully supported f **Framework versions**: Versions up to Java SE 17 -### [JavaScript](../../getting-started/supported-languages-and-frameworks/javascript/) +### [JavaScript](javascript/) **Frameworks**: @@ -365,7 +365,7 @@ Here you can find information about the programming languages, fully supported f * Vue.js * Express * jQuery -* Angular (partial support) +* Angular **Import your app through SCM**: Available @@ -378,7 +378,7 @@ Here you can find information about the programming languages, fully supported f **Framework versions**: Versions up to ECMAScript 2020 -### [Kotlin](../../getting-started/supported-languages-and-frameworks/java-and-kotlin/) +### [Kotlin](java-and-kotlin/) **Import your app through SCM**: Available @@ -390,7 +390,7 @@ Here you can find information about the programming languages, fully supported f * Interfile is supported * Android is partially supported -### [PHP](../../getting-started/supported-languages-and-frameworks/php.md) +### [PHP](php.md) **Frameworks**: @@ -409,7 +409,7 @@ Here you can find information about the programming languages, fully supported f **Framework versions**: Versions 5.2 up to 8.0 -### [Python](../../getting-started/supported-languages-and-frameworks/python.md) +### [Python](python.md) **Frameworks**: @@ -431,7 +431,7 @@ Here you can find information about the programming languages, fully supported f **Framework versions**: Versions up to 3.8.x -### [Ruby](../../getting-started/supported-languages-and-frameworks/ruby.md) +### [Ruby](ruby.md) **Frameworks**: Ruby On Rails @@ -444,7 +444,7 @@ Here you can find information about the programming languages, fully supported f * Reports * Custom rules -### [Scala](../../getting-started/supported-languages-and-frameworks/scala.md) +### [Scala](scala.md) **Frameworks**: @@ -463,7 +463,7 @@ Here you can find information about the programming languages, fully supported f **Framework versions**: Version 2.x -### [Swift](../../getting-started/supported-languages-and-frameworks/swift-and-objective-c.md) +### [Swift](swift-and-objective-c.md) **Frameworks**: @@ -482,7 +482,7 @@ Here you can find information about the programming languages, fully supported f **Framework versions**: Versions up to 5.7.x -### [TypeScript](../../getting-started/supported-languages-and-frameworks/typescript.md) +### [TypeScript](typescript.md) **Frameworks**: npm @@ -497,7 +497,7 @@ Here you can find information about the programming languages, fully supported f **Framework versions**: Versions up to 4.2 -### [VB.NET](../../getting-started/supported-languages-and-frameworks/vb.net.md) +### [VB.NET](vb.net.md) **Frameworks**: NuGet diff --git a/docs/getting-started/supported-languages-and-frameworks/java-and-kotlin/best-practices-for-java-and-kotlin.md b/docs/getting-started/supported-languages-and-frameworks/java-and-kotlin/best-practices-for-java-and-kotlin.md index c9a8d7672318..ef740a3e38f3 100644 --- a/docs/getting-started/supported-languages-and-frameworks/java-and-kotlin/best-practices-for-java-and-kotlin.md +++ b/docs/getting-started/supported-languages-and-frameworks/java-and-kotlin/best-practices-for-java-and-kotlin.md @@ -96,7 +96,7 @@ Use the `--help` option in the CLI for details of Snyk CLI commands. #### Testing your own code: -* Framework support - see [Snyk Code - Supported languages and frameworks](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/). +* Framework support - see [Snyk Code - Supported languages and frameworks](../). * Use the **snyk code test** command from the root of the project to perform source code analysis. * Use **--scan-all-unmanaged --all-projects** to recursively find all jars under the present working directory. diff --git a/docs/getting-started/supported-languages-and-frameworks/javascript/README.md b/docs/getting-started/supported-languages-and-frameworks/javascript/README.md index 7e7152f0e62d..1bfd61a8ad02 100644 --- a/docs/getting-started/supported-languages-and-frameworks/javascript/README.md +++ b/docs/getting-started/supported-languages-and-frameworks/javascript/README.md @@ -10,7 +10,7 @@ Snyk Code supports the following frameworks: * Vue.js * Express * jQuery -* Angular (partial support) +* Angular * NodeJS ### Open source and licensing diff --git a/docs/getting-started/supported-languages-and-frameworks/javascript/best-practices-for-javascript-and-node.js.md b/docs/getting-started/supported-languages-and-frameworks/javascript/best-practices-for-javascript-and-node.js.md index 06ebb19c0bbc..3f55fe09c91d 100644 --- a/docs/getting-started/supported-languages-and-frameworks/javascript/best-practices-for-javascript-and-node.js.md +++ b/docs/getting-started/supported-languages-and-frameworks/javascript/best-practices-for-javascript-and-node.js.md @@ -136,7 +136,7 @@ If you are using a package manager that requires options, it’s suggested to ta #### Codebase -* Framework support - see [Supported languages, frameworks, and feature availability overview](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/). +* Framework support - see [Supported languages, frameworks, and feature availability overview](../). * Use the `snyk code test` command from the root of the Project to perform source code analysis. #### Containers diff --git a/docs/getting-started/supported-languages-and-frameworks/technical-specifications.md b/docs/getting-started/supported-languages-and-frameworks/technical-specifications.md index 08ee489ab135..da6c154d0111 100644 --- a/docs/getting-started/supported-languages-and-frameworks/technical-specifications.md +++ b/docs/getting-started/supported-languages-and-frameworks/technical-specifications.md @@ -200,7 +200,7 @@ Snyk scans your codebase following this sequence ### More information about language support for Snyk Code -For more information, see [Supported languages, frameworks, and feature availability overview, Snyk Code section](../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/#code-analysis-snyk-code). +For more information, see [Supported languages, frameworks, and feature availability overview, Snyk Code section](./#code-analysis-snyk-code). ### Code Quality @@ -220,6 +220,6 @@ The way Snyk analyzes and builds the graph varies depending on the language and ### More information about language support for Snyk Open Source -For more information, see [Supported languages, frameworks, and feature availability overview, Open Source section](../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/#open-source-and-licensing-snyk-open-source). +For more information, see [Supported languages, frameworks, and feature availability overview, Open Source section](./#open-source-and-licensing-snyk-open-source). \ diff --git a/docs/integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-azure-repositories-tfs-integration.md b/docs/integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-azure-repositories-tfs-integration.md index bf66694e1b19..097ee3ce3316 100644 --- a/docs/integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-azure-repositories-tfs-integration.md +++ b/docs/integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-azure-repositories-tfs-integration.md @@ -81,7 +81,7 @@ If the connection to Azure fails, a notification appears under the **Azure Repos ## Add Projects to Snyk for Azure Repos -Snyk tests and monitors Azure Repos by evaluating root folders and custom file locations for the [languages that Snyk supports](../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/). +Snyk tests and monitors Azure Repos by evaluating root folders and custom file locations for the [languages that Snyk supports](../../getting-started/supported-languages-and-frameworks/). To add a default Project: diff --git a/docs/integrate-with-snyk/snyk-ci-cd-integrations/teamcity-jetbrains-integration-using-the-snyk-security-plugin/language-support-for-teamcity-integration.md b/docs/integrate-with-snyk/snyk-ci-cd-integrations/teamcity-jetbrains-integration-using-the-snyk-security-plugin/language-support-for-teamcity-integration.md index 00dae8e6e5ed..9ff552d078dc 100644 --- a/docs/integrate-with-snyk/snyk-ci-cd-integrations/teamcity-jetbrains-integration-using-the-snyk-security-plugin/language-support-for-teamcity-integration.md +++ b/docs/integrate-with-snyk/snyk-ci-cd-integrations/teamcity-jetbrains-integration-using-the-snyk-security-plugin/language-support-for-teamcity-integration.md @@ -2,4 +2,4 @@ Snyk supports all TeamCity projects regardless of which Git repo is used. -All languages supported by both [TeamCity](https://www.jetbrains.com/teamcity/features/languages/) and [Snyk](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/) can be scanned for vulnerabilities by this plugin. +All languages supported by both [TeamCity](https://www.jetbrains.com/teamcity/features/languages/) and [Snyk](../../../getting-started/supported-languages-and-frameworks/) can be scanned for vulnerabilities by this plugin. diff --git a/docs/integrate-with-snyk/snyk-ci-cd-integrations/user-defined-custom-images-for-cli.md b/docs/integrate-with-snyk/snyk-ci-cd-integrations/user-defined-custom-images-for-cli.md index 25f45d185256..7d410a7499d0 100644 --- a/docs/integrate-with-snyk/snyk-ci-cd-integrations/user-defined-custom-images-for-cli.md +++ b/docs/integrate-with-snyk/snyk-ci-cd-integrations/user-defined-custom-images-for-cli.md @@ -16,7 +16,7 @@ Using custom images allows you to: In order for your custom image to be supported, it must: * Use an environment [supported](../../snyk-cli/install-or-update-the-snyk-cli/) by the Snyk CLI -* Use a language and framework [supported](../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/) by Snyk +* Use a language and framework [supported](../../getting-started/supported-languages-and-frameworks/) by Snyk * Have Snyk CLI installed on the image; see [Install or update the Snyk CLI](../../snyk-cli/install-or-update-the-snyk-cli/) for steps to install the CLI * Be publicly accessible; the integration will pull the image. diff --git a/docs/scan-with-snyk/pull-requests/pull-request-checks/configure-pull-request-checks.md b/docs/scan-with-snyk/pull-requests/pull-request-checks/configure-pull-request-checks.md index c95f47eee4ee..0da107f0ea06 100644 --- a/docs/scan-with-snyk/pull-requests/pull-request-checks/configure-pull-request-checks.md +++ b/docs/scan-with-snyk/pull-requests/pull-request-checks/configure-pull-request-checks.md @@ -29,7 +29,7 @@ You can analyze the changed code with PR Checks as follows: * Snyk Open Source: Snyk analyzes dependency manifest or supported files for known security vulnerabilities that meet a threshold, such as exceeding severity, or checks to determine whether a fix is available. * Open Source license check: Snyk validates package licenses against the configured policy for license policy violations. -PR Checks also support all programming languages and frameworks supported by the Snyk Code and Open Source engines. For more information, see programming language support for [Snyk Code](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/#code-analysis-snyk-code) and [Open Source](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/#open-source-and-licensing-snyk-open-source). +PR Checks also support all programming languages and frameworks supported by the Snyk Code and Open Source engines. For more information, see programming language support for [Snyk Code](../../../getting-started/supported-languages-and-frameworks/#code-analysis-snyk-code) and [Open Source](../../../getting-started/supported-languages-and-frameworks/#open-source-and-licensing-snyk-open-source). ## How configuration of PR Checks works diff --git a/docs/scan-with-snyk/snyk-code/README.md b/docs/scan-with-snyk/snyk-code/README.md index f308fa167c89..e63456a8c1a1 100644 --- a/docs/scan-with-snyk/snyk-code/README.md +++ b/docs/scan-with-snyk/snyk-code/README.md @@ -13,7 +13,7 @@ You can scan your code using the following options: The following table shows the Snyk Code features, including analysis, managing security issues in your code, and facilitating remediations within your development environment. -
FeatureDescription
Issue filtering, sorting, and grouping

To identify the most common problems, you can filter issues based on their severity, programming language, priority score, and other criteria.

See Filter existing Projects.

Priority Score

Sort by and prioritize the more important issues by incorporating factors such as issue prevalence, ease of fix, and risk factor into a single risk score.

See Priority score.

Data flow

Visualize the path of the issue from source to sink with a step-by-step flow.

See Data flow.

Vulnerability

Learn more about the vulnerability through curated content that explains how the vulnerability was created, what the risk factors are, and popular mitigation strategies for it.

See VManage code vulnerabilities

Fix analysis

Gain insight and context by examining examples with links to actual code that fixes the same issues in similar data flows.

See Breakdown of Code analysis.

Create Jira issue

Track and export Snyk issues to your Jira project.

See Create a Jira issue.

Ignore issues

Configure Snyk to ignore suggested fixes for an issue to suppress specific warnings. For example, you may have deliberately used hard-coded passwords to test your routines in test code, or you are aware of an issue but have decided not to fix it.

See Ignore issues.

Exclude files from the import process

Check for DeepCode/Snyk ignore files .gitignore .dcignore and read them if they exist. Using the information in these files, Snyk filters to identify only the files with the supported extensions in the Project directory and not above the current Project directory. Snyk Code bundles these files that are smaller than 4 MB and sends them to Snyk. ,gitignore exclusions are honored by the snyk code test CLI command.

See also Exclude directories and files from the import process.

+
FeatureDescription
Issue filtering, sorting, and grouping

To identify the most common problems, you can filter issues based on their severity, programming language, priority score, and other criteria.

See Filter existing Projects.

Priority Score

Sort by and prioritize the more important issues by incorporating factors such as issue prevalence, ease of fix, and risk factor into a single risk score.

See Priority score.

Data flow

Visualize the path of the issue from source to sink with a step-by-step flow.

See Data flow.

Vulnerability

Learn more about the vulnerability through curated content that explains how the vulnerability was created, what the risk factors are, and popular mitigation strategies for it.

See VManage code vulnerabilities

Fix analysis

Gain insight and context by examining examples with links to actual code that fixes the same issues in similar data flows.

See Breakdown of Code analysis.

Create Jira issue

Track and export Snyk issues to your Jira project.

See Create a Jira issue.

Ignore issues

Configure Snyk to ignore suggested fixes for an issue to suppress specific warnings. For example, you may have deliberately used hard-coded passwords to test your routines in test code, or you are aware of an issue but have decided not to fix it.

See Ignore issues.

Exclude files from the import process

Check for DeepCode/Snyk ignore files .gitignore .dcignore and read them if they exist. Using the information in these files, Snyk filters to identify only the files with the supported extensions in the Project directory and not above the current Project directory. Snyk Code bundles these files that are smaller than 4 MB and sends them to Snyk. ,gitignore exclusions are honored by the snyk code test CLI command.

See also Exclude directories and files from the import process.

## Deployment @@ -57,7 +57,7 @@ Snyk Code analysis can be applied to every pull request you create in your Git r ## Supported languages -Snyk Code supports many [languages and frameworks](../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/). +Snyk Code supports many [languages and frameworks](../../getting-started/supported-languages-and-frameworks/). ## What's next? diff --git a/docs/scan-with-snyk/snyk-code/configure-snyk-code.md b/docs/scan-with-snyk/snyk-code/configure-snyk-code.md index 1d2cdd2e589b..1cddf31cb2ac 100644 --- a/docs/scan-with-snyk/snyk-code/configure-snyk-code.md +++ b/docs/scan-with-snyk/snyk-code/configure-snyk-code.md @@ -15,7 +15,7 @@ Snyk Code only scans and tests new repositories that are imported to Snyk. If a Before scanning your code with Snyk Code, ensure the following: * You have completed the [Quickstart](../../getting-started/quickstart/). -* Your repositories contain code in a [supported language and platform](../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/). +* Your repositories contain code in a [supported language and platform](../../getting-started/supported-languages-and-frameworks/). ## Enable Snyk Code in Snyk Web UI diff --git a/docs/scan-with-snyk/snyk-code/manage-code-vulnerabilities/README.md b/docs/scan-with-snyk/snyk-code/manage-code-vulnerabilities/README.md index 006d0d13ce05..571dce7c1338 100644 --- a/docs/scan-with-snyk/snyk-code/manage-code-vulnerabilities/README.md +++ b/docs/scan-with-snyk/snyk-code/manage-code-vulnerabilities/README.md @@ -5,7 +5,7 @@ Before managing vulnerabilities with Snyk Code, ensure the following: * You have completed the [Quickstart](../../../getting-started/quickstart/). -* Your repositories contain code in a [supported language and platform](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/). +* Your repositories contain code in a [supported language and platform](../../../getting-started/supported-languages-and-frameworks/). * You have [configured Snyk Code](../configure-snyk-code.md). ## How Project testing works for Snyk Code @@ -44,7 +44,7 @@ You can change the display of the issues on the Code analysis page using the fol * Sorting from the **Highest** or the **Lowest** severity level. * Filtering discovered vulnerability issues according to different criteria shown in the following table. -
Vulnerability issue filterDescription
Severity levelShow issues with a certain severity level. Snyk Code uses only High, Medium, and Low severity levels, without Critical.
Priority scoreShow issues in a certain priority score range.
StatusShow Open issues or issues that were Ignored.
LanguagesShow issues that were discovered in code files that were written in a specific language. Only programming languages discovered in the analyzed repository are displayed in the Filter pane.
Vulnerability typesShow issues with a certain Vulnerability Type. See Snyk Code security rules.
+
Vulnerability issue filterDescription
Severity levelShow issues with a certain severity level. Snyk Code uses only High, Medium, and Low severity levels, without Critical.
Priority scoreShow issues in a certain priority score range.
StatusShow Open issues or issues that were Ignored.
LanguagesShow issues that were discovered in code files that were written in a specific language. Only programming languages discovered in the analyzed repository are displayed in the Filter pane.
Vulnerability typesShow issues with a certain Vulnerability Type. See Snyk Code security rules.
Overview of vulnerability issue filtering, sorting, and grouping.

Vulnerability issue filtering, sorting, and grouping

diff --git a/docs/scan-with-snyk/snyk-container/how-snyk-container-works/supported-operating-system-distributions.md b/docs/scan-with-snyk/snyk-container/how-snyk-container-works/supported-operating-system-distributions.md index a758f84baaeb..5cc1604e4ac1 100644 --- a/docs/scan-with-snyk/snyk-container/how-snyk-container-works/supported-operating-system-distributions.md +++ b/docs/scan-with-snyk/snyk-container/how-snyk-container-works/supported-operating-system-distributions.md @@ -3,8 +3,8 @@ {% hint style="info" %} For information on the environments supported with other Snyk products, see: -* [Snyk Open Source - supported languages and package managers](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/#open-source-and-licensing-snyk-open-source) -* [Snyk Code - Supported languages and frameworks](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/#code-analysis-snyk-code) +* [Snyk Open Source - supported languages and package managers](../../../getting-started/supported-languages-and-frameworks/#open-source-and-licensing-snyk-open-source) +* [Snyk Code - Supported languages and frameworks](../../../getting-started/supported-languages-and-frameworks/#code-analysis-snyk-code) * [Snyk IaC and Cloud - Supported providers](../../snyk-iac/supported-iac-languages-cloud-providers-and-cloud-resources/) {% endhint %} diff --git a/docs/scan-with-snyk/snyk-iac/supported-iac-languages-cloud-providers-and-cloud-resources/README.md b/docs/scan-with-snyk/snyk-iac/supported-iac-languages-cloud-providers-and-cloud-resources/README.md index 394127d8f21d..dffbe492d15c 100644 --- a/docs/scan-with-snyk/snyk-iac/supported-iac-languages-cloud-providers-and-cloud-resources/README.md +++ b/docs/scan-with-snyk/snyk-iac/supported-iac-languages-cloud-providers-and-cloud-resources/README.md @@ -1,7 +1,7 @@ # Supported IaC languages, cloud providers, and cloud resources {% hint style="info" %} -For environments supported with other Snyk products, see [Supported languages and frameworks](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/). +For environments supported with other Snyk products, see [Supported languages and frameworks](../../../getting-started/supported-languages-and-frameworks/). {% endhint %} Use Snyk IaC to find, view, and fix issues in infrastructure configuration files for Terraform, Kubernetes Manifests, AWS CloudFormation, Azure Resource Manager (ARM), and Helm Charts. diff --git a/docs/scan-with-snyk/snyk-open-source/README.md b/docs/scan-with-snyk/snyk-open-source/README.md index 35d2f3992aad..578d105d3de3 100644 --- a/docs/scan-with-snyk/snyk-open-source/README.md +++ b/docs/scan-with-snyk/snyk-open-source/README.md @@ -10,7 +10,7 @@ Sometimes, these issues are rooted deep in the code. Open-source packages often Snyk Open Source allows you to find and fix vulnerabilities in the open-source libraries used by your applications. You can also find and address licensing issues in or caused by these open-source libraries. -Snyk Open Source is available in many common languages and platforms. See [Supported languages and package managers](../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/). +Snyk Open Source is available in many common languages and platforms. See [Supported languages and package managers](../../getting-started/supported-languages-and-frameworks/). ## Find and fix vulnerabilities diff --git a/docs/scan-with-snyk/snyk-open-source/manage-vulnerabilities/troubleshoot-fixing-vulnerabilities-with-snyk-open-source.md b/docs/scan-with-snyk/snyk-open-source/manage-vulnerabilities/troubleshoot-fixing-vulnerabilities-with-snyk-open-source.md index 3d191d50cae8..15dab7bec791 100644 --- a/docs/scan-with-snyk/snyk-open-source/manage-vulnerabilities/troubleshoot-fixing-vulnerabilities-with-snyk-open-source.md +++ b/docs/scan-with-snyk/snyk-open-source/manage-vulnerabilities/troubleshoot-fixing-vulnerabilities-with-snyk-open-source.md @@ -13,7 +13,7 @@ Snyk can generate Fix Pull Requests (Fix PRs) or Merge Requests (MRs) for depend Snyk supports creating Fix PRs or MRs for the following languages: * [Maven](../../../getting-started/supported-languages-and-frameworks/java-and-kotlin/best-practices-for-java-and-kotlin.md#maven) -* [.NET](../../supported-languages-and-frameworks/.net/) +* [.NET](../../../getting-started/supported-languages-and-frameworks/.net/) * [npm](../../../getting-started/supported-languages-and-frameworks/javascript/best-practices-for-javascript-and-node.js.md#npm) * [Python](../../../getting-started/supported-languages-and-frameworks/python.md) * [Ruby](../../../getting-started/supported-languages-and-frameworks/ruby.md) diff --git a/docs/snyk-admin/groups-and-organizations/group-and-organization-settings.md b/docs/snyk-admin/groups-and-organizations/group-and-organization-settings.md index 61d5e9f5d512..8e23776f039a 100644 --- a/docs/snyk-admin/groups-and-organizations/group-and-organization-settings.md +++ b/docs/snyk-admin/groups-and-organizations/group-and-organization-settings.md @@ -40,7 +40,7 @@ From the Organization setting menu, select **Settings** and then select one of t * **General**: See [Organization general settings](organizations/organization-general-settings.md) for details. * **Service Accounts**: See [Service accounts](../../enterprise-configuration/service-accounts/) for details. * **Integrations**: Set up integrations and see a list of those configured for your Organization; click the name of the configured integration to see the details. See [Integrate with Snyk](https://docs.snyk.io/integrations) for information about available Snyk integrations. -* **Languages**: Enable Reachable vulnerabilities analysis and edit language settings; see [Snyk Open Source - supported languages and package managers](../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/) for details. +* **Languages**: Enable Reachable vulnerabilities analysis and edit language settings; see [Snyk Open Source - supported languages and package managers](../../getting-started/supported-languages-and-frameworks/) for details. * **Snyk Code**: Enable Snyk Code; see the [Snyk Code](../../scan-with-snyk/snyk-code/) documentation for details. * **Snyk Iac:** Enable Snyk Iac, detecting configuration files, and rules. Select severity levels for configurations scanned. See the [IaC ](../../scan-with-snyk/snyk-iac/scan-your-iac-source-code/)documentation for details. * **Usage**: See the [Usage settings](usage-settings.md) page for details. diff --git a/docs/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-cli-for-open-source/README.md b/docs/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-cli-for-open-source/README.md index 6e8e9e714159..a4d21e40ce2f 100644 --- a/docs/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-cli-for-open-source/README.md +++ b/docs/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-cli-for-open-source/README.md @@ -44,9 +44,9 @@ When `snyk test` runs, it tries to autodetect your Project type by looking for a The way Snyk analyzes the file and builds the tree varies depending on the following: -* The [language and package manager](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/) you use, as determined by the manifest file type +* The [language and package manager](../../../getting-started/supported-languages-and-frameworks/) you use, as determined by the manifest file type * The method of scanning, using the [Snyk CLI](../../), or importing a Project using a [Git repository integration](../../../integrate-with-snyk/git-repositories-scms-integrations-with-snyk/) -For tips on running `snyk test` with commonly used options, see [Use options to customize the snyk test command](use-options-to-customize-the-snyk-test-command.md). For more information about supported languages, see [Open Source language and package manager support](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/). +For tips on running `snyk test` with commonly used options, see [Use options to customize the snyk test command](use-options-to-customize-the-snyk-test-command.md). For more information about supported languages, see [Open Source language and package manager support](../../../getting-started/supported-languages-and-frameworks/). -See [Open Source language and package manager support](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/) for more information concerning supported languages. +See [Open Source language and package manager support](../../../getting-started/supported-languages-and-frameworks/) for more information concerning supported languages. diff --git a/docs/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-cli-for-snyk-code/README.md b/docs/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-cli-for-snyk-code/README.md index bdc44b6e9319..49a33abff87d 100644 --- a/docs/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-cli-for-snyk-code/README.md +++ b/docs/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-cli-for-snyk-code/README.md @@ -9,7 +9,7 @@ Before using the Snyk CLI for testing your source code with Snyk Code, verify yo * A Snyk account.\ For more information, see [Create a Snyk account](../../../getting-started/quickstart/create-or-log-in-to-a-snyk-account.md). * Repositories with code in a supported language and framework.\ - For more information, see [Snyk Code - Supported languages and frameworks](../../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/). + For more information, see [Snyk Code - Supported languages and frameworks](../../../getting-started/supported-languages-and-frameworks/). * The **Snyk Code** option [enabled in your Snyk Org settings](../../../scan-with-snyk/snyk-code/configure-snyk-code.md). * The Snyk CLI installed and authenticated. * For instructions, see [Install or update the Snyk CLI](../../install-or-update-the-snyk-cli/) and [Authenticate the Snyk CLI](../../authenticate-the-cli-with-your-account.md). From 9aae5fa2b7cd226a00d7124bfebb57de5f6840d0 Mon Sep 17 00:00:00 2001 From: Natasha Ellingford Date: Thu, 30 May 2024 16:00:41 +0000 Subject: [PATCH 03/12] GITBOOK-7217: NE - Snyk GitHub Enterprise integration: repo permissions table reference. --- .../snyk-github-enterprise-integration.md | 8 +++++++- .../snyk-github-integration.md | 4 ++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-github-enterprise-integration.md b/docs/integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-github-enterprise-integration.md index 0017c8033dfa..80861046165d 100644 --- a/docs/integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-github-enterprise-integration.md +++ b/docs/integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-github-enterprise-integration.md @@ -163,7 +163,13 @@ You can re-connect anytime; however, re-initiating GitHub Enterprise projects fo ## Required access scopes for Snyk GitHub Enterprise integration -All the operations, whether triggered manually or automatically, are performed for a GitHub service account that has its token configured on the integrations settings page. This shows the required access scopes for the configured token. GitHub custom roles are not supported : +All the operations, whether triggered manually or automatically, are performed for a GitHub service account that has its token configured on the integrations settings page. + +{% hint style="info" %} +For details on repository-level permissions requirements, please see [Required permission scope for repositories](https://docs.snyk.io/integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-github-integration#h\_01eefvj14p8b3depeffvyvdwzj). These apply to both the GitHub Enterprise integration and the GitHub integration. +{% endhint %} + +This shows the required access scopes for the configured token. GitHub custom roles are not supported : | **Action** | **Purpose** | **Required scope in GitHub** | | ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-github-integration.md b/docs/integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-github-integration.md index c80706c2c672..2fb5ae38663b 100644 --- a/docs/integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-github-integration.md +++ b/docs/integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-github-integration.md @@ -176,6 +176,10 @@ For Snyk to perform the required operation on monitored repositories, that is, r | Opening fix and upgrade pull requests | Used to create fix and upgrade PRs in the monitored repos. | _Write_ or higher | | Snyk tests on pull requests - **initial configuration** |

Used to add SCM webhooks to the imported repos. Snyk uses these webhooks to:

  • Track the state of Snyk pull requests (when PRs are created, updated triggered, merged, and so on).
  • Send push events to trigger PR checks.
| _Admin_ | +{% hint style="info" %} +The [repository-level permission scopes](snyk-github-integration.md#h\_01eefvj14p8b3depeffvyvdwzj) apply to both the GitHub and GitHub Enterprise integration. +{% endhint %} + ## **How to set up a GitHub account to open Snyk PRs** Snyk lets you designate a specific GitHub account to open fix and upgrade pull requests. From dc36c886f39665021035a595ca28bc63850d519c Mon Sep 17 00:00:00 2001 From: Ann Wiley Date: Thu, 30 May 2024 16:12:54 +0000 Subject: [PATCH 04/12] GITBOOK-7218: API: REST overview, add link to changelog in versioning section --- docs/snyk-api/snyk-rest-api-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/snyk-api/snyk-rest-api-overview.md b/docs/snyk-api/snyk-rest-api-overview.md index d6115d7b9c50..7379ad0951f6 100644 --- a/docs/snyk-api/snyk-rest-api-overview.md +++ b/docs/snyk-api/snyk-rest-api-overview.md @@ -76,7 +76,7 @@ HTTP/1.1 400 Bad Request ## Versioning -Snyk REST API has per-endpoint version contracts. Each endpoint can have its own release and support lifecycle, independent of any other endpoint in Snyk REST API. In its most explicit form, the endpoint version number includes a date and stability tree, for example: +Snyk REST API has per-endpoint version contracts. For information about the differences in versions, see the [API Changelog](https://docs.snyk.io/snyk-api/changelog). Each endpoint can have its own release and support lifecycle, independent of any other endpoint in the Snyk REST API. In its most explicit form, the endpoint version number includes a date and stability tree, for example: ``` 2023-11-27~beta From 6f7c596421d4e5fc883fe5815c43a5c25c17e75f Mon Sep 17 00:00:00 2001 From: Ann Wiley Date: Thu, 30 May 2024 16:19:28 +0000 Subject: [PATCH 05/12] GITBOOK-7219: API: REST API overview, specify changelog for GA endpoints --- docs/snyk-api/snyk-rest-api-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/snyk-api/snyk-rest-api-overview.md b/docs/snyk-api/snyk-rest-api-overview.md index 7379ad0951f6..436c8b6b8be7 100644 --- a/docs/snyk-api/snyk-rest-api-overview.md +++ b/docs/snyk-api/snyk-rest-api-overview.md @@ -76,7 +76,7 @@ HTTP/1.1 400 Bad Request ## Versioning -Snyk REST API has per-endpoint version contracts. For information about the differences in versions, see the [API Changelog](https://docs.snyk.io/snyk-api/changelog). Each endpoint can have its own release and support lifecycle, independent of any other endpoint in the Snyk REST API. In its most explicit form, the endpoint version number includes a date and stability tree, for example: +Snyk REST API has per-endpoint version contracts. For information about the differences in GA versions, see the [API Changelog](https://docs.snyk.io/snyk-api/changelog). Each endpoint can have its own release and support lifecycle, independent of any other endpoint in the Snyk REST API. In its most explicit form, the endpoint version number includes a date and stability tree, for example: ``` 2023-11-27~beta From 0ca1352db22b99d88df4deecb365f466735ea1d4 Mon Sep 17 00:00:00 2001 From: Ann Wiley Date: Fri, 31 May 2024 04:24:42 +0000 Subject: [PATCH 06/12] GITBOOK-7221: Broker main page, fix code markup for npm install --- docs/enterprise-configuration/snyk-broker/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/enterprise-configuration/snyk-broker/README.md b/docs/enterprise-configuration/snyk-broker/README.md index 528435fdd8f3..48522f153d2e 100644 --- a/docs/enterprise-configuration/snyk-broker/README.md +++ b/docs/enterprise-configuration/snyk-broker/README.md @@ -14,7 +14,7 @@ Snyk Broker is an open-source tool that acts as a proxy between Snyk and special Snyk Broker is hosted on [GitHub](https://github.com/snyk/broker) and published as a set of Docker images for specific integrations. Snyk provides a [Helm Chart](https://github.com/snyk/snyk-broker-helm) to deploy Snyk Broker if you are using Kubernetes. To deploy Broker, you must install and configure an integration. -You can install and configure using [Helm](install-and-configure-snyk-broker/install-and-configure-broker-using-helm.md) or [Docker](install-and-configure-snyk-broker/install-and-configure-broker-using-docker.md). You can install using Docker to run the Snyk Broker Client or run npm `install snyk-broker`. Snyk recommends using Helm as the simplest way to deploy Snyk Broker. +You can install and configure using [Helm](install-and-configure-snyk-broker/install-and-configure-broker-using-helm.md) or [Docker](install-and-configure-snyk-broker/install-and-configure-broker-using-docker.md). You can install using Docker to run the Snyk Broker Client or run `npm install snyk-broker`. Snyk recommends using Helm as the simplest way to deploy Snyk Broker. ## **Integrations with Snyk Broker** From a36acacb286203d17ee9881a90910cf1f813bd8d Mon Sep 17 00:00:00 2001 From: Natasha Ellingford Date: Fri, 31 May 2024 09:30:31 +0000 Subject: [PATCH 07/12] GITBOOK-7222: NE - Integrate with Snyk: Move package repository integs to OS --- docs/SUMMARY.md | 24 +++++++++---------- ...sitory-install-and-configure-using-helm.md | 2 +- ...snyk-broker-with-artifactory-repository.md | 2 +- ...sitory-install-and-configure-using-helm.md | 2 +- ...yk-broker-with-nexus-repository-manager.md | 2 +- .../prepare-snyk-broker-for-deployment.md | 2 +- .../java-and-kotlin/README.md | 4 ++-- .../best-practices-for-java-and-kotlin.md | 10 ++++---- ...st-practices-for-javascript-and-node.js.md | 4 ++-- .../trial-limitations.md | 2 +- docs/integrate-with-snyk/README.md | 4 ++-- .../gatekeeper-plugins/README.md | 0 .../artifactory-gatekeeper-plugin.md | 2 +- ...us-repository-manager-gatekeeper-plugin.md | 0 .../package-repository-integrations/README.md | 0 .../README.md | 6 ++--- .../artifactory-registry-for-maven.md | 4 ++-- .../artifactory-registry-for-npm.md | 4 ++-- .../README.md | 6 ++--- .../nexus-repository-manager-for-maven.md | 4 ++-- .../nexus-repository-manager-for-npm.md | 6 ++--- ...pm-teams-and-npm-enterprise-integration.md | 8 +++---- ...vate-gem-sources-for-ruby-configuration.md | 4 ++-- .../using-fips-validated-cryptography.md | 2 +- 24 files changed, 52 insertions(+), 52 deletions(-) rename docs/scan-using-snyk/snyk-open-source/{scan-open-source-libraries-and-licenses => manage-vulnerabilities}/gatekeeper-plugins/README.md (100%) rename docs/scan-using-snyk/snyk-open-source/{scan-open-source-libraries-and-licenses => manage-vulnerabilities}/gatekeeper-plugins/artifactory-gatekeeper-plugin.md (96%) rename docs/scan-using-snyk/snyk-open-source/{scan-open-source-libraries-and-licenses => manage-vulnerabilities}/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md (100%) rename docs/{integrate-with-snyk => scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses}/package-repository-integrations/README.md (100%) rename docs/{integrate-with-snyk => scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses}/package-repository-integrations/artifactory-package-repository-connection-setup/README.md (61%) rename docs/{integrate-with-snyk => scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses}/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md (87%) rename docs/{integrate-with-snyk => scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses}/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-npm.md (81%) rename docs/{integrate-with-snyk => scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses}/package-repository-integrations/nexus-repository-manager-connection-setup/README.md (80%) rename docs/{integrate-with-snyk => scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses}/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-maven.md (90%) rename docs/{integrate-with-snyk => scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses}/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-npm.md (89%) rename docs/{integrate-with-snyk => scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses}/package-repository-integrations/npm-teams-and-npm-enterprise-integration.md (75%) rename docs/{integrate-with-snyk => scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses}/package-repository-integrations/private-gem-sources-for-ruby-configuration.md (85%) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index ec5739e4dc1e..ff1a41ee183e 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -399,15 +399,6 @@ * [Jira integration](integrate-with-snyk/jira-and-slack-integrations/jira-integration.md) * [Slack app](integrate-with-snyk/jira-and-slack-integrations/slack-app.md) * [Slack integration](integrate-with-snyk/jira-and-slack-integrations/slack-integration.md) - * [Package repository integrations](integrate-with-snyk/package-repository-integrations/README.md) - * [Artifactory Package Repository connection setup](integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/README.md) - * [Artifactory Registry for Maven](integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md) - * [Artifactory Registry for npm](integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-npm.md) - * [Nexus Repository Manager connection setup](integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/README.md) - * [Nexus Repository Manager for Maven](integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-maven.md) - * [Nexus Repository Manager for npm](integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-npm.md) - * [npm Teams and npm Enterprise integration](integrate-with-snyk/package-repository-integrations/npm-teams-and-npm-enterprise-integration.md) - * [Private gem sources for Ruby configuration](integrate-with-snyk/package-repository-integrations/private-gem-sources-for-ruby-configuration.md) * [Cloud platforms integrations](integrate-with-snyk/cloud-platforms-integrations/README.md) * [AWS Integration](integrate-with-snyk/cloud-platforms-integrations/aws-integration/README.md) * [AWS Integration: Web UI](integrate-with-snyk/cloud-platforms-integrations/aws-integration/aws-integration-web-ui/README.md) @@ -491,11 +482,20 @@ * [Scan open-source libraries and licenses](scan-with-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/README.md) * [Open-source license compliance](scan-with-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/open-source-license-compliance.md) * [Snyk License Compliance Management](scan-with-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/snyk-license-compliance-management.md) - * [Gatekeeper plugins](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/README.md) - * [Artifactory Gatekeeper Plugin](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/artifactory-gatekeeper-plugin.md) - * [Nexus Repository Manager Gatekeeper Plugin](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md) + * [Package repository integrations](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/README.md) + * [Artifactory Package Repository connection setup](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/README.md) + * [Artifactory Registry for Maven](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md) + * [Artifactory Registry for npm](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-npm.md) + * [Nexus Repository Manager connection setup](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/README.md) + * [Nexus Repository Manager for Maven](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-maven.md) + * [Nexus Repository Manager for npm](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-npm.md) + * [npm Teams and npm Enterprise integration](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/npm-teams-and-npm-enterprise-integration.md) + * [Private gem sources for Ruby configuration](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/private-gem-sources-for-ruby-configuration.md) * [Manage vulnerabilities](scan-with-snyk/snyk-open-source/manage-vulnerabilities/README.md) * [Fix your vulnerabilities](scan-with-snyk/snyk-open-source/manage-vulnerabilities/fix-your-vulnerabilities.md) + * [Gatekeeper plugins](scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/README.md) + * [Artifactory Gatekeeper Plugin](scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/artifactory-gatekeeper-plugin.md) + * [Nexus Repository Manager Gatekeeper Plugin](scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md) * [Vulnerability fix types](scan-with-snyk/snyk-open-source/manage-vulnerabilities/vulnerability-fix-types.md) * [Upgrade package versions to fix vulnerabilities](scan-with-snyk/snyk-open-source/manage-vulnerabilities/upgrade-package-versions-to-fix-vulnerabilities.md) * [Snyk patches to fix vulnerabilities](scan-with-snyk/snyk-open-source/manage-vulnerabilities/snyk-patches-to-fix-vulnerabilities.md) diff --git a/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/artifactory-repository-install-and-configure-broker/artifactory-repository-install-and-configure-using-helm.md b/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/artifactory-repository-install-and-configure-broker/artifactory-repository-install-and-configure-using-helm.md index 7ce0d45a72cd..69c70fd12df4 100644 --- a/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/artifactory-repository-install-and-configure-broker/artifactory-repository-install-and-configure-using-helm.md +++ b/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/artifactory-repository-install-and-configure-broker/artifactory-repository-install-and-configure-using-helm.md @@ -10,7 +10,7 @@ For more information, see [Plans and pricing](https://snyk.io/plans). Before installing, review the [prerequisites](./) and the general instructions for installation using [Helm](../install-and-configure-broker-using-helm.md). -For information about non-brokered integration with Artifactory Repository see [Artifactory Repository setup](../../../../integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/). For information about brokered integration with Artifactory Container Registry see [Snyk Broker -Container Registry Agent](https://docs.snyk.io/snyk-admin/snyk-broker/snyk-broker-container-registry-agent). +For information about non-brokered integration with Artifactory Repository see [Artifactory Repository setup](../../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/). For information about brokered integration with Artifactory Container Registry see [Snyk Broker -Container Registry Agent](https://docs.snyk.io/snyk-admin/snyk-broker/snyk-broker-container-registry-agent). To use this chart, you must first add the Snyk Broker Helm Chart by adding the repo: diff --git a/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/artifactory-repository-install-and-configure-broker/set-up-snyk-broker-with-artifactory-repository.md b/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/artifactory-repository-install-and-configure-broker/set-up-snyk-broker-with-artifactory-repository.md index bfbc9b990e2c..6bd17a9a6c8b 100644 --- a/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/artifactory-repository-install-and-configure-broker/set-up-snyk-broker-with-artifactory-repository.md +++ b/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/artifactory-repository-install-and-configure-broker/set-up-snyk-broker-with-artifactory-repository.md @@ -12,7 +12,7 @@ Before installing, review the [prerequisites](./) and the general instructions f This integration is useful to ensure a secure connection with your on-premise Artifactory Repository deployment. -For information about non-brokered integration with Artifactory Repository see [Artifactory Repository setup](../../../../integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/). For information about brokered integration with Artifactory Container Registry see [Snyk Broker -Container Registry Agent](https://docs.snyk.io/snyk-admin/snyk-broker/snyk-broker-container-registry-agent). +For information about non-brokered integration with Artifactory Repository see [Artifactory Repository setup](../../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/). For information about brokered integration with Artifactory Container Registry see [Snyk Broker -Container Registry Agent](https://docs.snyk.io/snyk-admin/snyk-broker/snyk-broker-container-registry-agent). ## Configure Broker to be used for Artifactory Registry diff --git a/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/nexus-repository-prerequisites-and-steps-to-install-and-configure-broker/nexus-repository-install-and-configure-using-helm.md b/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/nexus-repository-prerequisites-and-steps-to-install-and-configure-broker/nexus-repository-install-and-configure-using-helm.md index 258f9355121b..3a9faa49dbed 100644 --- a/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/nexus-repository-prerequisites-and-steps-to-install-and-configure-broker/nexus-repository-install-and-configure-using-helm.md +++ b/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/nexus-repository-prerequisites-and-steps-to-install-and-configure-broker/nexus-repository-install-and-configure-using-helm.md @@ -8,7 +8,7 @@ Integration with Nexus Repository Manager is available only for Enterprise plans For more information, see [Plans and pricing](https://snyk.io/plans). {% endhint %} -For information about non-brokered integration with Nexus Repository Manager including supported environments and versions and user permissions, see [Nexus Repository Manager setup](../../../../integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/). For information about brokered integration with Artifactory or Nexus Container Registry see [Snyk Broker -Container Registry Agent](../../snyk-broker-container-registry-agent/). +For information about non-brokered integration with Nexus Repository Manager including supported environments and versions and user permissions, see [Nexus Repository Manager setup](../../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/). For information about brokered integration with Artifactory or Nexus Container Registry see [Snyk Broker -Container Registry Agent](../../snyk-broker-container-registry-agent/). ## Nexus 3 Helm installation diff --git a/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/nexus-repository-prerequisites-and-steps-to-install-and-configure-broker/set-up-snyk-broker-with-nexus-repository-manager.md b/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/nexus-repository-prerequisites-and-steps-to-install-and-configure-broker/set-up-snyk-broker-with-nexus-repository-manager.md index 1768e31f0cf9..b1e3fbd3f4bd 100644 --- a/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/nexus-repository-prerequisites-and-steps-to-install-and-configure-broker/set-up-snyk-broker-with-nexus-repository-manager.md +++ b/docs/enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/nexus-repository-prerequisites-and-steps-to-install-and-configure-broker/set-up-snyk-broker-with-nexus-repository-manager.md @@ -12,7 +12,7 @@ Before installing, review the [prerequisites](./) and the general instructions f This integration is useful to ensure a secure connection with your on-premise Nexus Repository Manager deployment. -For information about non-brokered integration with Nexus Repository Manager including supported environments and versions and user permissions, see [Nexus Repository Manager setup](../../../../integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/). For information about brokered integration with Nexus Container Registry see [Snyk Broker -Container Registry Agent](../../snyk-broker-container-registry-agent/). +For information about non-brokered integration with Nexus Repository Manager including supported environments and versions and user permissions, see [Nexus Repository Manager setup](../../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/). For information about brokered integration with Nexus Container Registry see [Snyk Broker -Container Registry Agent](../../snyk-broker-container-registry-agent/). ## Configure Broker to be used for Nexus plugins diff --git a/docs/enterprise-configuration/snyk-broker/prepare-snyk-broker-for-deployment.md b/docs/enterprise-configuration/snyk-broker/prepare-snyk-broker-for-deployment.md index 9455d79fb3ff..3202af711370 100644 --- a/docs/enterprise-configuration/snyk-broker/prepare-snyk-broker-for-deployment.md +++ b/docs/enterprise-configuration/snyk-broker/prepare-snyk-broker-for-deployment.md @@ -76,7 +76,7 @@ For code repository (SCM) integrations, a Broker token can be generated using th 1. Navigate to the Snyk API v1 documentation and follow the example under "Set up a broker for an existing integration" within the [Integrations API](https://snyk.docs.apiary.io/#reference/integrations/integration/update-existing-integration) or contact [Snyk support](https://support.snyk.io/hc/en-us/requests/new). 2. Verify the Broker token is generated in the Snyk Web UI under the specified SCM integration. by selecting **Settings** > **Integrations** for that specific integration to see the Broker token. -For [Artifactory Repository](../../integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/) and [Nexus Repository Manager](../../integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/) brokered instances or [Jira](install-and-configure-snyk-broker/jira-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-jira.md) integration, you can generate a Broker token in the Snyk UI or contact [Snyk support](https://support.snyk.io/hc/en-us/requests/new). +For [Artifactory Repository](../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/) and [Nexus Repository Manager](../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/) brokered instances or [Jira](install-and-configure-snyk-broker/jira-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-jira.md) integration, you can generate a Broker token in the Snyk UI or contact [Snyk support](https://support.snyk.io/hc/en-us/requests/new). 1. Select **Settings** > **Integrations** for that specific integration to generate the Broker token. 2. After the Broker token is generated, under the integration, the notification from this screen correctly displays **Could not connect to…**, as you have not yet installed and configured the client. diff --git a/docs/getting-started/supported-languages-and-frameworks/java-and-kotlin/README.md b/docs/getting-started/supported-languages-and-frameworks/java-and-kotlin/README.md index 07b5b46fc163..7571ac028956 100644 --- a/docs/getting-started/supported-languages-and-frameworks/java-and-kotlin/README.md +++ b/docs/getting-started/supported-languages-and-frameworks/java-and-kotlin/README.md @@ -349,7 +349,7 @@ The following table includes the Git services available for Maven and Gradle Pro #### Git settings for Java -From the Snyk UI, you can specify mirrors or repositories from which you’d like to resolve packages in Artifactory for Maven. For more information, see [Artifactory Registry for Maven](../../../integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md). +From the Snyk UI, you can specify mirrors or repositories from which you’d like to resolve packages in Artifactory for Maven. For more information, see [Artifactory Registry for Maven](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md). The following table includes the Git services available for Maven and Gradle Projects. @@ -436,7 +436,7 @@ Artifactory and Nexus Package Registry integrations are available to Snyk Enterp * Snyk Open Source uses Artifactory or Nexus to resolve transitive dependencies through private packages. * Snyk can be connected to a publicly available instance using username and password or a private server on your network using the Snyk Broker. -* Snyk Open Source provides integrations with Artifactory and Nexus both as local gatekeeper, and interacting with the registry for security testing. See [Nexus Repository Manager setup](../../../integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/) and [Artifactory Registry setup](../../../integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/) +* Snyk Open Source provides integrations with Artifactory and Nexus both as local gatekeeper, and interacting with the registry for security testing. See [Nexus Repository Manager setup](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/) and [Artifactory Registry setup](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/) {% hint style="info" %} If you are not a Snyk Enterprise user and you use Artifactory or Nexus, analysis is best performed using CLI as the build system will retrieve the dependencies and be present locally. diff --git a/docs/getting-started/supported-languages-and-frameworks/java-and-kotlin/best-practices-for-java-and-kotlin.md b/docs/getting-started/supported-languages-and-frameworks/java-and-kotlin/best-practices-for-java-and-kotlin.md index ef740a3e38f3..b1426cc6e9b7 100644 --- a/docs/getting-started/supported-languages-and-frameworks/java-and-kotlin/best-practices-for-java-and-kotlin.md +++ b/docs/getting-started/supported-languages-and-frameworks/java-and-kotlin/best-practices-for-java-and-kotlin.md @@ -8,7 +8,7 @@ Artifactory and Nexus Package Registry integrations are available to Snyk Enterp * Snyk Open Source uses Artifactory or Nexus to resolve transitive dependencies through private packages. * Snyk can be connected to a publicly available instance using username and password or a private server on your network using the Snyk Broker. -* Snyk Open Source provides integrations with Artifactory and Nexus, both as local gatekeepers and interacting with the registry for security testing. See [Nexus Repository Manager setup](../../../integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/) and [Artifactory Registry setup](../../../integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/) +* Snyk Open Source provides integrations with Artifactory and Nexus, both as local gatekeepers and interacting with the registry for security testing. See [Nexus Repository Manager setup](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/) and [Artifactory Registry setup](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/) {% hint style="info" %} If you are not a Snyk Enterprise user using Artifactory or Nexus, analysis is best performed via CLI, as the build system will retrieve the dependencies and be present locally. @@ -16,11 +16,11 @@ If you are not a Snyk Enterprise user using Artifactory or Nexus, analysis is be For more information on package registry integrations, including Maven, see the following: -* Package registry integrations: [Nexus Repository Manager setup](../../../integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/) and [Artifactory Registry setup](../../../integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/) -* [Artifactory Registry for Maven](../../../integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md) -* [Nexus Registry for Maven](../../../integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-maven.md) +* Package registry integrations: [Nexus Repository Manager setup](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/) and [Artifactory Registry setup](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/) +* [Artifactory Registry for Maven](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md) +* [Nexus Registry for Maven](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-maven.md) * Nexus Container Registry: [Container security with Nexus integration](../../../integrate-with-snyk/snyk-container-integrations/container-security-with-nexus-integration.md) -* Gatekeeper plugins: [Artifactory Gatekeeper plugin](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/artifactory-gatekeeper-plugin.md) and [Nexus Repository Manager Gatekeeper plugin](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md) +* Gatekeeper plugins: [Artifactory Gatekeeper plugin](../../../scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/artifactory-gatekeeper-plugin.md) and [Nexus Repository Manager Gatekeeper plugin](../../../scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md) ## Language and package manager considerations diff --git a/docs/getting-started/supported-languages-and-frameworks/javascript/best-practices-for-javascript-and-node.js.md b/docs/getting-started/supported-languages-and-frameworks/javascript/best-practices-for-javascript-and-node.js.md index 3f55fe09c91d..fd8bba501caf 100644 --- a/docs/getting-started/supported-languages-and-frameworks/javascript/best-practices-for-javascript-and-node.js.md +++ b/docs/getting-started/supported-languages-and-frameworks/javascript/best-practices-for-javascript-and-node.js.md @@ -33,8 +33,8 @@ If your Projects reference private dependencies in these repositories but you ar For more information, see the following: -* Package registry integrations: [npm Teams and npm Enterprise](../../../integrate-with-snyk/package-repository-integrations/npm-teams-and-npm-enterprise-integration.md), [Artifactory Registry setup](../../../integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/) and [Nexus Repository Manager setup](../../../integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/). -* Gatekeeper plugins: [Artifactory Gatekeeper plugin](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/artifactory-gatekeeper-plugin.md) and [Nexus Repository Manager Gatekeeper plugin](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md) +* Package registry integrations: [npm Teams and npm Enterprise](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/npm-teams-and-npm-enterprise-integration.md), [Artifactory Registry setup](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/) and [Nexus Repository Manager setup](../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/). +* Gatekeeper plugins: [Artifactory Gatekeeper plugin](../../../scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/artifactory-gatekeeper-plugin.md) and [Nexus Repository Manager Gatekeeper plugin](../../../scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md) ## Language and package manager considerations diff --git a/docs/implement-snyk/enterprise-implementation-guide/trial-limitations.md b/docs/implement-snyk/enterprise-implementation-guide/trial-limitations.md index 363f56368d4c..920c5942c339 100644 --- a/docs/implement-snyk/enterprise-implementation-guide/trial-limitations.md +++ b/docs/implement-snyk/enterprise-implementation-guide/trial-limitations.md @@ -15,7 +15,7 @@ The following Enterprise features are limited or unavailable during the trial: * [**Snyk Code Local Engine**](../../scan-with-snyk/snyk-code/snyk-code-local-engine.md): Not available. * [**Broker**](../../enterprise-configuration/snyk-broker/): Not available. * [**Self-hosted Git**](../../integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-github-enterprise-integration.md): Not available. -* [**Private Registry Integrations**](../../integrate-with-snyk/package-repository-integrations/): Not available. +* [**Private Registry Integrations**](../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/): Not available. {% hint style="info" %} Need more help? [Contact Snyk Support](https://support.snyk.io/hc/en-us/requests/new). diff --git a/docs/integrate-with-snyk/README.md b/docs/integrate-with-snyk/README.md index 9607dfa262d7..bfeb545246c2 100644 --- a/docs/integrate-with-snyk/README.md +++ b/docs/integrate-with-snyk/README.md @@ -9,8 +9,8 @@ This section of the Snyk user docs explains how to set up and use many types of Snyk provides plugins for repository gatekeepers and integrations to connect with package repositories: -* [Gatekeeper plugins](../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/) -* [Package repository integrations](package-repository-integrations/) +* [Gatekeeper plugins](../scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/) +* [Package repository integrations](../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/) Additional integrations support working with Snyk Container and Snyk Iac: diff --git a/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/README.md b/docs/scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/README.md similarity index 100% rename from docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/README.md rename to docs/scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/README.md diff --git a/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/artifactory-gatekeeper-plugin.md b/docs/scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/artifactory-gatekeeper-plugin.md similarity index 96% rename from docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/artifactory-gatekeeper-plugin.md rename to docs/scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/artifactory-gatekeeper-plugin.md index 6e940ebdca13..f21d9e80ddc9 100644 --- a/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/artifactory-gatekeeper-plugin.md +++ b/docs/scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/artifactory-gatekeeper-plugin.md @@ -18,7 +18,7 @@ By scanning artifacts as part of your workflow and then displaying those test re **Note**\ This page refers to the Artifactory Plugin, an independent piece of software that is installed on the Artifactory machine and serves as a gatekeeper, blocking vulnerable packages from being downloaded from the Artifactory instance. -This plugin is separate from the [Artifactory Registry for Maven](../../../../integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md), a Snyk integration that allows configuring SCM scans to use custom package registries. +This plugin is separate from the [Artifactory Registry for Maven](../../scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md), a Snyk integration that allows configuring SCM scans to use custom package registries. {% endhint %} ## Package managers supported by the Artifactory Plugin diff --git a/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md b/docs/scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md similarity index 100% rename from docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md rename to docs/scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md diff --git a/docs/integrate-with-snyk/package-repository-integrations/README.md b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/README.md similarity index 100% rename from docs/integrate-with-snyk/package-repository-integrations/README.md rename to docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/README.md diff --git a/docs/integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/README.md b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/README.md similarity index 61% rename from docs/integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/README.md rename to docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/README.md index 0cdcac1a2a1f..61c44cef679f 100644 --- a/docs/integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/README.md +++ b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/README.md @@ -7,7 +7,7 @@ This feature is available with Enterprise plans. See [pricing plans](https://sny {% hint style="info" %} **Supported Projects**\ -The Artifactory Package Repository integration currently supports [Node.js](../../../getting-started/supported-languages-and-frameworks/javascript/#supported-frameworks-and-package-managers) (npm and Yarn) and [Maven](../../../getting-started/supported-languages-and-frameworks/java-and-kotlin/#supported-frameworks-and-package-managers) Projects. Gradle Projects are not currently supported. +The Artifactory Package Repository integration currently supports [Node.js](../../../../../getting-started/supported-languages-and-frameworks/javascript/#supported-frameworks-and-package-managers) (npm and Yarn) and [Maven](../../../../../getting-started/supported-languages-and-frameworks/java-and-kotlin/#supported-frameworks-and-package-managers) Projects. Gradle Projects are not currently supported. {% endhint %} Connecting a custom Artifactory Package Repository enables Snyk to resolve all direct and transitive dependencies of packages hosted on the custom registry and calculate a more complete, accurate dependency graph and related vulnerabilities. @@ -17,7 +17,7 @@ You can configure these types of Artifactory Package Repository: * Publicly accessible instances protected by basic authentication * Instances on a private network accessed through Snyk Broker (with or without basic authentication). -These instructions apply to configuring publicly accessible instances. For instructions on configuring a brokered instance, see [Set up Snyk Broker with Artifactory Repository](../../../enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/artifactory-repository-install-and-configure-broker/set-up-snyk-broker-with-artifactory-repository.md). +These instructions apply to configuring publicly accessible instances. For instructions on configuring a brokered instance, see [Set up Snyk Broker with Artifactory Repository](../../../../../enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/artifactory-repository-install-and-configure-broker/set-up-snyk-broker-with-artifactory-repository.md). The steps to set up Artifactory Repository Manager follow. @@ -26,4 +26,4 @@ The steps to set up Artifactory Repository Manager follow. 3. Enter your username and password. 4. Select **Save**. -
Artifactory integration setup

Artifactoryrepository setup

+
Artifactory integration setup

Artifactoryrepository setup

diff --git a/docs/integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md similarity index 87% rename from docs/integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md rename to docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md index 7169e919e0d1..69a14fefbf1e 100644 --- a/docs/integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md +++ b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md @@ -15,13 +15,13 @@ Maven Projects can be configured to mirror all requests through a custom package If authentication is required to access your custom registry, you must configure the Artifactory package repository integration; see [Artifactory Registry setup](./). -Once the integration is set up, you can configure Maven settings by navigating to settings ![Settings](../../../.gitbook/assets/cog\_icon.png) **> Languages > Java**. +Once the integration is set up, you can configure Maven settings by navigating to settings ![Settings](../../../../../.gitbook/assets/cog\_icon.png) **> Languages > Java**. You can choose whether to use Artifactory as a mirror or as an additional repository where your artifacts will reside. These settings will be very similar to what you have in `~/.m2/settings.xml`. ### **Mirrors** -
Maven settings, choose Type

Maven settings, choose Type

+
Maven settings, choose Type

Maven settings, choose Type

Choose a value for the Type, either **Direct** or, if you are using authentication, **Integration.** diff --git a/docs/integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-npm.md b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-npm.md similarity index 81% rename from docs/integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-npm.md rename to docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-npm.md index 33040ffb5ed1..d606a4da6fc5 100644 --- a/docs/integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-npm.md +++ b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-npm.md @@ -19,7 +19,7 @@ Note that this guide is relevant for Snyk UI integrations only. The CLI already ## JavaScript language settings -1. Go to settings Settings **> Languages > JavaScript** and either the npm or Yarn settings depending on your project types +1. Go to settings Settings **> Languages > JavaScript** and either the npm or Yarn settings depending on your project types 2. If you have not previously connected to Artifactory you will be asked to configure an integration first; see [Artifactory Registry setup](./). 3. Select **Add registry configuration**. 1. Select **Artifactory** as the Package source. @@ -32,4 +32,4 @@ Note that this guide is relevant for Snyk UI integrations only. The CLI already Open a Pull/Merge Request on a Project that contains private dependencies that are hosted in Artifactory to see **a lockfile updated and included in the Snyk Fix Pull Request with the correct URL to your repository**. -
Pull request to test Artifactory integration

Pull request to test Artifactory integration

+
Pull request to test Artifactory integration

Pull request to test Artifactory integration

diff --git a/docs/integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/README.md b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/README.md similarity index 80% rename from docs/integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/README.md rename to docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/README.md index cdf630e731ae..a68b9fa93e40 100644 --- a/docs/integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/README.md +++ b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/README.md @@ -7,7 +7,7 @@ This feature is available with Enterprise plans. See [pricing plans](https://sny {% hint style="info" %} **Supported Projects**\ -The Nexus Repository Manager integration currently supports [Node.js](../../../getting-started/supported-languages-and-frameworks/javascript/#supported-frameworks-and-package-managers) (npm and Yarn) and [Maven](../../../getting-started/supported-languages-and-frameworks/java-and-kotlin/#supported-frameworks-and-package-managers) Projects. Gradle Projects are not currently supported. +The Nexus Repository Manager integration currently supports [Node.js](../../../../../getting-started/supported-languages-and-frameworks/javascript/#supported-frameworks-and-package-managers) (npm and Yarn) and [Maven](../../../../../getting-started/supported-languages-and-frameworks/java-and-kotlin/#supported-frameworks-and-package-managers) Projects. Gradle Projects are not currently supported. {% endhint %} Connecting Nexus Repository Manager enables Snyk to resolve all direct and transitive dependencies of packages hosted on the Nexus registry and calculate a more complete, accurate dependency graph and related vulnerabilities. @@ -24,14 +24,14 @@ You can configure these types of Nexus Repository Manager: * Nexus Repository Manager version 2.15+ is in Beta {% endhint %} -These instructions apply to configuring publicly accessible instances. For instructions on configuring a brokered instance see [Set up Snyk Broker with Nexus Repository Manager](../../../enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/nexus-repository-prerequisites-and-steps-to-install-and-configure-broker/set-up-snyk-broker-with-nexus-repository-manager.md) +These instructions apply to configuring publicly accessible instances. For instructions on configuring a brokered instance see [Set up Snyk Broker with Nexus Repository Manager](../../../../../enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/nexus-repository-prerequisites-and-steps-to-install-and-configure-broker/set-up-snyk-broker-with-nexus-repository-manager.md) ## Set up publicly accessible instances 1. Navigate to **Settings** > **Integrations > Package Repositories > Nexus** 2. Verify that you see the screen to configure Nexus. -
Configure Nexus

Configure Nexus

+
Configure Nexus

Configure Nexus

On the page to configure Nexus, enter the information for the version you are using. diff --git a/docs/integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-maven.md b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-maven.md similarity index 90% rename from docs/integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-maven.md rename to docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-maven.md index 494f8747bfb0..b576fc6484a9 100644 --- a/docs/integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-maven.md +++ b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-maven.md @@ -15,7 +15,7 @@ Maven Projects can be configured to mirror all requests through a custom package If authentication is required to access your Nexus registry, you must first configure the Nexus Repository Manager integration. See [Nexus Repository Manager setup](./). -Once the integration is set up, you can configure Maven settings by navigating to settings ![Settings icon](../../../.gitbook/assets/cog\_icon.png) **> Languages > Java**. +Once the integration is set up, you can configure Maven settings by navigating to settings ![Settings icon](../../../../../.gitbook/assets/cog\_icon.png) **> Languages > Java**. You can choose whether to use Nexus as a mirror or as an additional repository where your artifacts will reside. @@ -23,7 +23,7 @@ These settings are very similar to what you have in `~/.m2/settings.xml`. ### **Mirrors** -
Set up for Mirrors

Set up for Mirrors

+
Set up for Mirrors

Set up for Mirrors

Choose a value for the Type, either **Direct** or, if you are using using authentication, **Integration**. diff --git a/docs/integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-npm.md b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-npm.md similarity index 89% rename from docs/integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-npm.md rename to docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-npm.md index 9bf91dbe6fca..149771f6faff 100644 --- a/docs/integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-npm.md +++ b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-npm.md @@ -21,11 +21,11 @@ This guide is relevant for Snyk Web UI integrations only, the Snyk CLI already s ## JavaScript Language Settings -Go to settings **> Languages > JavaScript** and either the npm or yarn settings depending on your project types. +Go to settings **> Languages > JavaScript** and either the npm or yarn settings depending on your project types. If you have not previously connected to Nexus Repository Manager you will be asked to configure an integration first, see [.](./ "mention") -![](<../../../.gitbook/assets/Screenshot 2022-07-15 at 14.18.43.png>) +![](<../../../../../.gitbook/assets/Screenshot 2022-07-15 at 14.18.43.png>) Now follow the steps below, according to your version of Nexus. @@ -58,4 +58,4 @@ Now follow the steps below, according to your version of Nexus. Open a Pull/Merge Request on a project that contains private dependencies that are hosted in Nexus to see **a lockfile updated and included in the Snyk Fix Pull Request with the correct URL to your repository.** -![](<../../../.gitbook/assets/Screenshot 2022-07-15 at 14.22.59.png>) +![](<../../../../../.gitbook/assets/Screenshot 2022-07-15 at 14.22.59.png>) diff --git a/docs/integrate-with-snyk/package-repository-integrations/npm-teams-and-npm-enterprise-integration.md b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/npm-teams-and-npm-enterprise-integration.md similarity index 75% rename from docs/integrate-with-snyk/package-repository-integrations/npm-teams-and-npm-enterprise-integration.md rename to docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/npm-teams-and-npm-enterprise-integration.md index fccbf1c0d9bd..9950762a357f 100644 --- a/docs/integrate-with-snyk/package-repository-integrations/npm-teams-and-npm-enterprise-integration.md +++ b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/npm-teams-and-npm-enterprise-integration.md @@ -21,7 +21,7 @@ This guide is relevant for Snyk Web UI integrations only. The Snyk CLI already s ## JavaScript language settings -1. Go to settings Settings **> Languages > JavaScript** and either the npm or Yarn settings, depending on your Project types. Yarn is shown in the screenshots that follow. +1. Go to settings Settings **> Languages > JavaScript** and either the npm or Yarn settings, depending on your Project types. Yarn is shown in the screenshots that follow. 2. If you have not previously connected to npm Teams or npm Enterprise, you will be asked to configure an integration first. See [npm Teams and npm Enterprise registry settings](npm-teams-and-npm-enterprise-integration.md#npm-teams-and-npm-enterprise-registry-settings). 3. After you have set up the integration, select **Add registry configuration.** 1. Select **npm** as the Package source. @@ -31,15 +31,15 @@ This guide is relevant for Snyk Web UI integrations only. The Snyk CLI already s 4. When you have added all the registries and scopes you want, click **Update settings**. 5. to test the integration, open a Pull/Merge Request on a Project that contains private dependencies to see a lockfile updated and included in the Snyk Fix Pull Request where previously none was generated. -
Test of npm integration

Test of npm integration

+
Test of npm integration

Test of npm integration

## npm Teams and npm Enterprise registry settings You can configure token-based authentication for npm Teams and npm Enterprise integrations. -1. Go to settings > **Integrations > Package Repositories > npm.** +1. Go to settings > **Integrations > Package Repositories > npm.** 2. You should see the **Credentials** screen at the beginning. 3. Enter **Public URL** and **Token** values. 4. Click **Save**. -
npm credentials screen

npm credentials screen

+
npm credentials screen

npm credentials screen

diff --git a/docs/integrate-with-snyk/package-repository-integrations/private-gem-sources-for-ruby-configuration.md b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/private-gem-sources-for-ruby-configuration.md similarity index 85% rename from docs/integrate-with-snyk/package-repository-integrations/private-gem-sources-for-ruby-configuration.md rename to docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/private-gem-sources-for-ruby-configuration.md index baa40882e2e2..7f26e3252b54 100644 --- a/docs/integrate-with-snyk/package-repository-integrations/private-gem-sources-for-ruby-configuration.md +++ b/docs/scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/private-gem-sources-for-ruby-configuration.md @@ -13,14 +13,14 @@ This guide is relevant for Snyk UI integrations only. The CLI supports Ruby Proj ## Configuration of private gem sources for Ruby -1. Go to settings Settings > **General**. +1. Go to settings Settings > **General**. 2. Find the `RubyGems Bundler environment variables` section (see the screen illustration). 3. Add environment variable names and values to define credentials for gem sources.\ These are generally the same as the values you set on your developer machine, in your CI environments, or both.\ Example name: `BUNDLE_GITHUB__COM`, Value: `abcd0123generatedtoken:x-oauth-basic` 4. To test the configuration, open a Pull/Merge Request on a Project that contains gems from your private registries to see a lockfile updated and included in the Snyk Fix Pull Request. -
RubyGems Bundler environment variables

RubyGems Bundler environment variables

+
RubyGems Bundler environment variables

RubyGems Bundler environment variables

## Requirements for configuration of private gem sources for Ruby diff --git a/docs/snyk-cli/security-concept-of-operations-for-snyk/using-fips-validated-cryptography.md b/docs/snyk-cli/security-concept-of-operations-for-snyk/using-fips-validated-cryptography.md index 95792bcd4a3d..6059c756b1ff 100644 --- a/docs/snyk-cli/security-concept-of-operations-for-snyk/using-fips-validated-cryptography.md +++ b/docs/snyk-cli/security-concept-of-operations-for-snyk/using-fips-validated-cryptography.md @@ -119,4 +119,4 @@ FIPS in [CI/CD Integrations](../../integrate-with-snyk/snyk-ci-cd-integrations/) ## FIPS-validated cryptography support and use in Package Repositories -The [Snyk Nexus Repository Manager Gatekeeper plugin](../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md) and the [Artifactory Gatekeeper plugin](../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/artifactory-gatekeeper-plugin.md) use the Snyk API and run on a Java VM. To make use of FIPS-validated cryptography, configure the Java Runtime to use a FIPS-validated[ JCE (Java Cryptography Extension)](https://csrc.nist.gov/projects/cryptographic-module-validation-program/validated-modules/search?SearchMode=Basic\&ModuleName=java\&CertificateStatus=Active\&ValidationYear=0). +The [Snyk Nexus Repository Manager Gatekeeper plugin](../../scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md) and the [Artifactory Gatekeeper plugin](../../scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/artifactory-gatekeeper-plugin.md) use the Snyk API and run on a Java VM. To make use of FIPS-validated cryptography, configure the Java Runtime to use a FIPS-validated[ JCE (Java Cryptography Extension)](https://csrc.nist.gov/projects/cryptographic-module-validation-program/validated-modules/search?SearchMode=Basic\&ModuleName=java\&CertificateStatus=Active\&ValidationYear=0). From c0b586bdcaf666e58dc63d0199e6322e5e56030c Mon Sep 17 00:00:00 2001 From: Jatin Naik Date: Thu, 30 May 2024 17:07:59 +0100 Subject: [PATCH 08/12] feat: add the ability to specify a category specific context --- tools/api-docs-generator/README.md | 14 +++ tools/api-docs-generator/config.yml | 5 +- tools/api-docs-generator/config/config.go | 31 ++++-- .../api-docs-generator/config/config_test.go | 4 +- .../fetcher/spec_fetcher.go | 2 +- .../generator/reference_docs.go | 30 ++++-- .../generator/reference_docs_test.go | 96 ++++++++++++++++++- 7 files changed, 161 insertions(+), 21 deletions(-) diff --git a/tools/api-docs-generator/README.md b/tools/api-docs-generator/README.md index 176f0c5789e0..e0674d53a5ef 100644 --- a/tools/api-docs-generator/README.md +++ b/tools/api-docs-generator/README.md @@ -15,6 +15,20 @@ To generate the API documentation locally, run: make run ``` +## Config + +Generator is configured with `config.yml`. The following options are available: + +categoryContext: additional context for the category of the API documentation, for example: +```yaml +categoryContext: + - name: licenses-v1 + hint: | + **Note:** When you import or update Projects, changes will be reflected in the endpoint results after a one-hour delay. +``` +will add a hint on the top of the `licenses` category, for the v1 API. + + ## Development To test the utility, run: diff --git a/tools/api-docs-generator/config.yml b/tools/api-docs-generator/config.yml index 45bee283f9f1..1dcbe9a97be8 100644 --- a/tools/api-docs-generator/config.yml +++ b/tools/api-docs-generator/config.yml @@ -7,6 +7,9 @@ specs: docsHint: This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). - path: docs/.gitbook/assets/rest-spec.json docsHint: This document uses the REST API. For more details, see the [Authentication for API](../authentication-for-api/) page. - +categoryContext: +- name: licenses-v1 + hint: | + **Note:** When you import or update Projects, changes will be reflected in the endpoint results after a one-hour delay. output: apiReferencePath: docs/snyk-api/reference \ No newline at end of file diff --git a/tools/api-docs-generator/config/config.go b/tools/api-docs-generator/config/config.go index a5b2a2bd47b6..b90e346deeb7 100644 --- a/tools/api-docs-generator/config/config.go +++ b/tools/api-docs-generator/config/config.go @@ -22,17 +22,36 @@ type Output struct { } type Config struct { - Fetcher Fetcher `yaml:"fetcher"` - Specs []Spec `yaml:"specs"` - Output Output `yaml:"output"` + Fetcher Fetcher `yaml:"fetcher"` + Specs []Spec `yaml:"specs"` + Output Output `yaml:"output"` + CategoryContext CategoryContexts `yaml:"categoryContext"` } -func Parse(filename string) (Config, error) { +type CategoryContexts []CategoryContext + +func (contexts CategoryContexts) ToMap() map[string]string { + m := make(map[string]string) + for i := range contexts { + m[contexts[i].Name] = contexts[i].Hint + } + return m +} + +type CategoryContext struct { + Name string `yaml:"name"` + Hint string `yaml:"hint"` +} + +func Parse(filename string) (*Config, error) { cfg := Config{} file, err := os.Open(filename) if err != nil { - return cfg, err + return nil, err } err = yaml.NewDecoder(file).Decode(&cfg) - return cfg, err + if err != nil { + return nil, err + } + return &cfg, err } diff --git a/tools/api-docs-generator/config/config_test.go b/tools/api-docs-generator/config/config_test.go index 0063c87e8d92..d35252794958 100644 --- a/tools/api-docs-generator/config/config_test.go +++ b/tools/api-docs-generator/config/config_test.go @@ -10,7 +10,7 @@ func TestParse(t *testing.T) { tests := []struct { name string args func() string - want Config + want *Config wantErr bool }{ { @@ -29,7 +29,7 @@ specs: output: apiReferencePath: snyk-api/reference`) }, - want: Config{ + want: &Config{ Fetcher: Fetcher{"source", "destination"}, Specs: []Spec{ {".gitbook/assets/spec.yaml", " (v1)", "hint 1"}, diff --git a/tools/api-docs-generator/fetcher/spec_fetcher.go b/tools/api-docs-generator/fetcher/spec_fetcher.go index 5c5f548cd8f9..b41425a646ff 100644 --- a/tools/api-docs-generator/fetcher/spec_fetcher.go +++ b/tools/api-docs-generator/fetcher/spec_fetcher.go @@ -15,7 +15,7 @@ import ( "github.com/snyk/user-docs/tools/api-docs-generator/config" ) -func FetchSpec(ctx context.Context, cfg config.Config, directory string) error { +func FetchSpec(ctx context.Context, cfg *config.Config, directory string) error { // #nosec G107 // cfg.Fetcher.Source is a URL from config and does not contain user input resp, err := get(ctx, cfg.Fetcher.Source) if err != nil { diff --git a/tools/api-docs-generator/generator/reference_docs.go b/tools/api-docs-generator/generator/reference_docs.go index 9b3fb0c3b29c..051d22f690ca 100644 --- a/tools/api-docs-generator/generator/reference_docs.go +++ b/tools/api-docs-generator/generator/reference_docs.go @@ -22,7 +22,7 @@ type operationPath struct { docsHint string } -func GenerateReferenceDocs(cfg config.Config, docsBasePath string) error { +func GenerateReferenceDocs(cfg *config.Config, docsBasePath string) error { aggregatedDocs, err := aggregateSpecs(cfg, docsBasePath) if err != nil { return err @@ -33,7 +33,7 @@ func GenerateReferenceDocs(cfg config.Config, docsBasePath string) error { destinationPath := path.Join(docsBasePath, cfg.Output.APIReferencePath, labelToFileName(label)) summary = append(summary, fmt.Sprintf("* [%s](%s)\n", label, path.Join(cfg.Output.APIReferencePath, labelToFileName(label)))) - err := renderReferenceDocsPage(destinationPath, label, docsBasePath, operations) + err := renderReferenceDocsPage(destinationPath, label, docsBasePath, operations, cfg.CategoryContext) if err != nil { return err } @@ -45,7 +45,7 @@ func GenerateReferenceDocs(cfg config.Config, docsBasePath string) error { return nil } -func aggregateSpecs(cfg config.Config, docsBasePath string) (map[string][]operationPath, error) { +func aggregateSpecs(cfg *config.Config, docsBasePath string) (map[string][]operationPath, error) { aggregatedDocs := map[string][]operationPath{} for _, spec := range cfg.Specs { @@ -73,17 +73,30 @@ func aggregateSpecs(cfg config.Config, docsBasePath string) (map[string][]operat return aggregatedDocs, nil } -func renderReferenceDocsPage(filePath, label, docsPath string, operation []operationPath) error { +func renderReferenceDocsPage(filePath, label, docsPath string, operation []operationPath, categoryContext config.CategoryContexts) error { docsFile, err := os.Create(filePath) if err != nil { return err } - fmt.Fprintf(docsFile, `# %s + _, err = fmt.Fprintf(docsFile, `# %s {%% hint style="info" %%} %s {%% endhint %%}`, label, operation[0].docsHint) + if err != nil { + return err + } + if categoryContextHint, found := categoryContext.ToMap()[labelToKey(label)]; found { + _, err = fmt.Fprintln(docsFile) + if err != nil { + return err + } + _, err = fmt.Fprint(docsFile, categoryContextHint) + if err != nil { + return err + } + } // sort for stability sort.Slice(operation, func(i, j int) bool { @@ -113,9 +126,14 @@ func renderReferenceDocsPage(filePath, label, docsPath string, operation []opera } func labelToFileName(label string) string { + return labelToKey(label) + ".md" +} + +func labelToKey(label string) string { replacements := []string{"(", ")"} for _, replacement := range replacements { label = strings.ReplaceAll(label, replacement, "") } - return strings.ToLower(strings.ReplaceAll(label, " ", "-")) + ".md" + + return strings.ToLower(strings.ReplaceAll(label, " ", "-")) } diff --git a/tools/api-docs-generator/generator/reference_docs_test.go b/tools/api-docs-generator/generator/reference_docs_test.go index 5168c6727bf4..a450dc0e9afb 100644 --- a/tools/api-docs-generator/generator/reference_docs_test.go +++ b/tools/api-docs-generator/generator/reference_docs_test.go @@ -5,6 +5,8 @@ import ( "path" "testing" + "github.com/snyk/user-docs/tools/api-docs-generator/config" + "github.com/stretchr/testify/assert" ) @@ -43,10 +45,11 @@ func Test_labelToFileName(t *testing.T) { func Test_renderReferenceDocsPage(t *testing.T) { type args struct { - filePath string - label string - docsPath string - operation []operationPath + filePath string + label string + docsPath string + operation []operationPath + categoryContext config.CategoryContexts } testDir := t.TempDir() tests := []struct { @@ -69,6 +72,84 @@ func Test_renderReferenceDocsPage(t *testing.T) { docsHint: "This is a hint", }, }, + categoryContext: config.CategoryContexts{}, + }, + checker: func(t *testing.T, args args) { + t.Helper() + content, err := os.ReadFile(args.filePath) + if err != nil { + t.Fatal(err) + } + renderedFileContents := string(content) + assert.Contains(t, renderedFileContents, "# Apps", "rendered file contains header") + assert.Contains(t, renderedFileContents, "This is a hint", "rendered file does not contain hint") + assert.Contains(t, renderedFileContents, `path="/apps"`, "rendered file does not contain path") + assert.Contains(t, renderedFileContents, `method="get"`, "rendered file does not contain method") + assert.Contains(t, renderedFileContents, `src="../foo/test/apps-spec.yaml"`, "renders relative path to spec file") + }, + }, + { + name: "renders reference docs page, with category context hint", + + args: args{ + filePath: createTempFile(t, testDir, "existing content"), + label: "Apps", + docsPath: testDir, + operation: []operationPath{ + { + specPath: "foo/test/apps-spec.yaml", + pathURL: "/apps", + method: "GET", + docsHint: "This is a hint", + }, + }, + categoryContext: config.CategoryContexts{ + { + Name: "apps", + Hint: "This is a hint from category context", + }, + { + Name: "not-apps", + Hint: "This is a hint from another context", + }, + }, + }, + checker: func(t *testing.T, args args) { + t.Helper() + content, err := os.ReadFile(args.filePath) + if err != nil { + t.Fatal(err) + } + renderedFileContents := string(content) + assert.Contains(t, renderedFileContents, "# Apps", "rendered file contains header") + assert.Contains(t, renderedFileContents, "This is a hint", "rendered file does not contain hint") + assert.Contains(t, renderedFileContents, `path="/apps"`, "rendered file does not contain path") + assert.Contains(t, renderedFileContents, `method="get"`, "rendered file does not contain method") + assert.Contains(t, renderedFileContents, `src="../foo/test/apps-spec.yaml"`, "renders relative path to spec file") + assert.Contains(t, renderedFileContents, `This is a hint from category context`, "renders category context hint") + }, + }, + { + name: "renders reference docs page, without category context hint if no matches", + + args: args{ + filePath: createTempFile(t, testDir, "existing content"), + label: "Apps", + docsPath: testDir, + operation: []operationPath{ + { + specPath: "foo/test/apps-spec.yaml", + pathURL: "/apps", + method: "GET", + docsHint: "This is a hint", + }, + }, + categoryContext: config.CategoryContexts{ + { + Name: "not-apps", + Hint: "This is a hint from category context", + }, + }, }, checker: func(t *testing.T, args args) { t.Helper() @@ -82,12 +163,17 @@ func Test_renderReferenceDocsPage(t *testing.T) { assert.Contains(t, renderedFileContents, `path="/apps"`, "rendered file does not contain path") assert.Contains(t, renderedFileContents, `method="get"`, "rendered file does not contain method") assert.Contains(t, renderedFileContents, `src="../foo/test/apps-spec.yaml"`, "renders relative path to spec file") + assert.NotContains(t, renderedFileContents, `This is a hint from category context`, "does not render category context hint") }, }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - if err := renderReferenceDocsPage(tt.args.filePath, tt.args.label, tt.args.docsPath, tt.args.operation); (err != nil) != tt.wantErr { + if err := renderReferenceDocsPage(tt.args.filePath, + tt.args.label, + tt.args.docsPath, + tt.args.operation, + tt.args.categoryContext); (err != nil) != tt.wantErr { t.Errorf("renderReferenceDocsPage() error = %v, wantErr %v", err, tt.wantErr) } tt.checker(t, tt.args) From 7166d0ab13a106321af6ddb0f3c03f32ae66b67c Mon Sep 17 00:00:00 2001 From: Natasha Ellingford Date: Fri, 31 May 2024 13:38:13 +0000 Subject: [PATCH 09/12] GITBOOK-7223: NE - fixing broken links From 862315bd7ac2f267b7b431a0f88011796fd1ff92 Mon Sep 17 00:00:00 2001 From: Jatin Naik Date: Fri, 31 May 2024 14:39:12 +0100 Subject: [PATCH 10/12] Improve docs generation - Filter out openapi category - Delete files before generation, making category renames possible - Print the menu only if the summary has changed --- tools/api-docs-generator/config.yml | 1 + tools/api-docs-generator/config/config.go | 1 + .../api-docs-generator/config/config_test.go | 2 +- .../generator/reference_docs.go | 53 +++++++++++++++++-- 4 files changed, 53 insertions(+), 4 deletions(-) diff --git a/tools/api-docs-generator/config.yml b/tools/api-docs-generator/config.yml index 1dcbe9a97be8..e4c45924cab9 100644 --- a/tools/api-docs-generator/config.yml +++ b/tools/api-docs-generator/config.yml @@ -12,4 +12,5 @@ categoryContext: hint: | **Note:** When you import or update Projects, changes will be reflected in the endpoint results after a one-hour delay. output: + summaryPath: docs/SUMMARY.md apiReferencePath: docs/snyk-api/reference \ No newline at end of file diff --git a/tools/api-docs-generator/config/config.go b/tools/api-docs-generator/config/config.go index b90e346deeb7..9ed8bbeecb6c 100644 --- a/tools/api-docs-generator/config/config.go +++ b/tools/api-docs-generator/config/config.go @@ -18,6 +18,7 @@ type Spec struct { } type Output struct { + SummaryPath string `yaml:"summaryPath"` APIReferencePath string `yaml:"apiReferencePath"` } diff --git a/tools/api-docs-generator/config/config_test.go b/tools/api-docs-generator/config/config_test.go index d35252794958..8de85ce26da9 100644 --- a/tools/api-docs-generator/config/config_test.go +++ b/tools/api-docs-generator/config/config_test.go @@ -35,7 +35,7 @@ output: {".gitbook/assets/spec.yaml", " (v1)", "hint 1"}, {".gitbook/assets/rest-spec.json", "", "hint 2"}, }, - Output: Output{"snyk-api/reference"}, + Output: Output{APIReferencePath: "snyk-api/reference"}, }, }, { diff --git a/tools/api-docs-generator/generator/reference_docs.go b/tools/api-docs-generator/generator/reference_docs.go index 051d22f690ca..4294ffaf4b13 100644 --- a/tools/api-docs-generator/generator/reference_docs.go +++ b/tools/api-docs-generator/generator/reference_docs.go @@ -29,19 +29,63 @@ func GenerateReferenceDocs(cfg *config.Config, docsBasePath string) error { } summary := make([]string, len(aggregatedDocs)) + err = clearDir(path.Join(docsBasePath, cfg.Output.APIReferencePath)) + if err != nil { + return err + } + for label, operations := range aggregatedDocs { destinationPath := path.Join(docsBasePath, cfg.Output.APIReferencePath, labelToFileName(label)) summary = append(summary, fmt.Sprintf("* [%s](%s)\n", label, path.Join(cfg.Output.APIReferencePath, labelToFileName(label)))) - err := renderReferenceDocsPage(destinationPath, label, docsBasePath, operations, cfg.CategoryContext) + err = renderReferenceDocsPage(destinationPath, label, docsBasePath, operations, cfg.CategoryContext) if err != nil { return err } } sort.Strings(summary) - fmt.Printf("generated menu for summary:\n") - fmt.Printf("%s", strings.Join(summary, "")) + matches, err := matchCurrentSummary(cfg.Output.SummaryPath, summary) + if err != nil { + return err + } + + if !matches { + fmt.Printf("generated menu for summary:\n") + fmt.Printf("%s", strings.Join(summary, "")) + } + + return nil +} + +func matchCurrentSummary(summaryPath string, summary []string) (bool, error) { + contents, err := os.ReadFile(summaryPath) + if err != nil { + return false, fmt.Errorf("failed to read summary file: %w", err) + } + currentSummary := string(contents) + for _, menuItem := range summary { + if !strings.Contains(currentSummary, menuItem) { + return false, nil + } + } + return true, nil +} + +func clearDir(dirName string) error { + dir, err := os.ReadDir(dirName) + if err != nil { + return err + } + for _, child := range dir { + if strings.HasPrefix(child.Name(), "README") { + continue + } + err = os.RemoveAll(path.Join(dirName, child.Name())) + if err != nil { + return err + } + } return nil } @@ -57,6 +101,9 @@ func aggregateSpecs(cfg *config.Config, docsBasePath string) (map[string][]opera for pathURL, pathItem := range doc.Paths.Map() { for method, operation := range pathItem.Operations() { for _, tag := range operation.Tags { + if tag == "OpenAPI" { + continue + } tag += spec.Suffix aggregatedDocs[tag] = append(aggregatedDocs[tag], operationPath{ operation: operation, From 041143d75595c85ff975245e330798d35eb42270 Mon Sep 17 00:00:00 2001 From: Jatin Naik Date: Fri, 31 May 2024 14:59:16 +0100 Subject: [PATCH 11/12] fix: path resolution for summary file --- tools/api-docs-generator/generator/reference_docs.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/api-docs-generator/generator/reference_docs.go b/tools/api-docs-generator/generator/reference_docs.go index 4294ffaf4b13..d64649bcfe2e 100644 --- a/tools/api-docs-generator/generator/reference_docs.go +++ b/tools/api-docs-generator/generator/reference_docs.go @@ -45,7 +45,7 @@ func GenerateReferenceDocs(cfg *config.Config, docsBasePath string) error { } sort.Strings(summary) - matches, err := matchCurrentSummary(cfg.Output.SummaryPath, summary) + matches, err := matchCurrentSummary(path.Join(docsBasePath, cfg.Output.SummaryPath), summary) if err != nil { return err } From 966f7b91dd9f7f9280eb46bdd658b526cd2ce3dc Mon Sep 17 00:00:00 2001 From: tinygrasshopper <451613+tinygrasshopper@users.noreply.github.com> Date: Fri, 31 May 2024 14:06:16 +0000 Subject: [PATCH 12/12] docs: synchronizing api spec with user-docs --- docs/.gitbook/assets/rest-spec.json | 76322 +++++++++++++--- docs/snyk-api/reference/audit-logs-v1.md | 1 - docs/snyk-api/reference/dependencies-v1.md | 1 - docs/snyk-api/reference/entitlements-v1.md | 1 - docs/snyk-api/reference/groups-v1.md | 1 - docs/snyk-api/reference/import-projects-v1.md | 1 - docs/snyk-api/reference/integrations-v1.md | 1 - docs/snyk-api/reference/licenses-v1.md | 1 - docs/snyk-api/reference/monitor-v1.md | 1 - docs/snyk-api/reference/openapi.md | 12 - docs/snyk-api/reference/organizations-v1.md | 1 - docs/snyk-api/reference/projects-v1.md | 1 - .../reference/pull-request-templates.md | 16 + docs/snyk-api/reference/reporting-api-v1.md | 1 - docs/snyk-api/reference/test-v1.md | 1 - docs/snyk-api/reference/users-v1.md | 1 - docs/snyk-api/reference/webhooks-v1.md | 1 - 17 files changed, 62081 insertions(+), 14283 deletions(-) delete mode 100644 docs/snyk-api/reference/openapi.md create mode 100644 docs/snyk-api/reference/pull-request-templates.md diff --git a/docs/.gitbook/assets/rest-spec.json b/docs/.gitbook/assets/rest-spec.json index c2a46cb92f83..611b037c7c19 100644 --- a/docs/.gitbook/assets/rest-spec.json +++ b/docs/.gitbook/assets/rest-spec.json @@ -304,14 +304,18 @@ "description": "A header containing the version of the endpoint requested by the caller.", "example": "2021-06-04", "schema": { - "$ref": "#/components/schemas/QueryVersion" + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" } }, "VersionServedResponseHeader": { "description": "A header containing the version of the endpoint that was served by the API.", "example": "2021-06-04", "schema": { - "$ref": "#/components/schemas/ActualVersion" + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" } }, "VersionStageResponseHeader": { @@ -503,14 +507,12 @@ } }, "GroupId": { - "description": "The ID of the Group.", - "example": "0d3728ec-eebf-484d-9907-ba238019f10b", + "description": "Group ID", "in": "path", "name": "group_id", "required": true, "schema": { - "format": "uuid", - "type": "string" + "$ref": "#/components/schemas/Uuid" } }, "Ignored": { @@ -603,14 +605,12 @@ "style": "form" }, "OrgId": { - "description": "The ID of the organization.", - "example": "0d3728ec-eebf-484d-9907-ba238019f10b", + "description": "Org ID", "in": "path", "name": "org_id", "required": true, "schema": { - "format": "uuid", - "type": "string" + "$ref": "#/components/schemas/Uuid" } }, "PackageUrl": { @@ -924,7 +924,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token.", + "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" @@ -1279,6 +1279,9 @@ "properties": { "client_id": { "$ref": "#/components/schemas/ClientId" + }, + "installed_at": { + "$ref": "#/components/schemas/InstalledAt" } }, "type": "object" @@ -1323,6 +1326,9 @@ }, "client_secret": { "$ref": "#/components/schemas/ClientSecret" + }, + "installed_at": { + "$ref": "#/components/schemas/InstalledAt" } }, "required": [ @@ -1844,7 +1850,7 @@ }, "ClientSecret": { "description": "The oauth2 client secret for the app. This is the only time this secret will be returned, store it securely and don’t lose it.", - "example": "snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht<]S_v1", + "example": "snyk_cs_ctZW0JsWG^Bm`*oPo=mnV26qU_6pjxht\u003c]S_v1", "minLength": 1, "type": "string" }, @@ -3037,9 +3043,6 @@ "format": "uuid", "type": "string" }, - "links": { - "$ref": "#/components/schemas/ErrorLink" - }, "meta": { "additionalProperties": true, "example": { @@ -3106,13 +3109,92 @@ } ], "items": { - "$ref": "#/components/schemas/Error" + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" }, "minItems": 1, "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ @@ -3129,7 +3211,46 @@ }, "properties": { "about": { - "$ref": "#/components/schemas/LinkProperty" + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] } }, "type": "object" @@ -3453,6 +3574,12 @@ ], "type": "string" }, + "InstalledAt": { + "description": "Timestamp at which this app was first installed at.", + "example": "2024-04-30T16:07:46.230044Z", + "format": "date-time", + "type": "string" + }, "IsActive": { "description": "Current status of the project settings.", "example": true, @@ -3809,7 +3936,123 @@ "properties": { "errors": { "items": { - "$ref": "#/components/schemas/Error" + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" }, "type": "array" } @@ -3892,7 +4135,19 @@ "type": "string" }, "meta": { - "$ref": "#/components/schemas/Meta" + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" } }, "required": [ @@ -5616,6 +5871,37 @@ }, "type": "object" }, + "PullRequestTemplateAttributes": { + "additionalProperties": false, + "minProperties": 1, + "properties": { + "branch_name": { + "description": "The name of the branch that will be created when the pull request is created", + "example": "chore/bump-{{package_name}}-{{package_from}}-{{package_to}}", + "minLength": 1, + "type": "string" + }, + "commit_message": { + "description": "The commit message that will be used when the pull request is created", + "example": "chore(deps): bump {{package_name}} from {{package_from}} to {{package_to}}", + "minLength": 1, + "type": "string" + }, + "description": { + "description": "The description of the pull request", + "example": "{{ #is_upgrade_pr }} This PR has been opened to make sure our repositories are kept up-to-date. It updates {{ package_name }} from version {{ package_from }} to version {{ package_to }}. Review relevant docs for possible breaking changes. {{ /is_upgrade_pr }}\n", + "minLength": 1, + "type": "string" + }, + "title": { + "description": "Specify a title for the pull request", + "example": "Snyk has created this PR to upgrade {{package_name}} from {{package_from}} to {{package_to}}.", + "minLength": 1, + "type": "string" + } + }, + "type": "object" + }, "PullRequestsSettings": { "additionalProperties": false, "description": "Settings which describe how pull requests for a project are tested.", @@ -5648,6 +5934,11 @@ }, "type": "object" }, + "PullRequsetTemplateId": { + "example": "https://api.snyk.io/rest/groups/7626925e-4b0f-11ee-be56-0242ac120002/pull_request_template", + "format": "uri", + "type": "string" + }, "QueryVersion": { "description": "Requested API version", "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", @@ -6287,7 +6578,7 @@ "type": "object" }, "id": { - "example": "slack://channel?team=T123456&id=C123456", + "example": "slack://channel?team=T123456\u0026id=C123456", "format": "uri", "type": "string" }, @@ -6389,7 +6680,7 @@ "type": "object" }, "TargetChannelId": { - "example": "slack://channel?team=team-id&id=channel-id", + "example": "slack://channel?team=team-id\u0026id=channel-id", "format": "uri", "type": "string" }, @@ -6569,7 +6860,7 @@ "properties": { "expression": { "description": "The regular expression used to describe the format of tags.\nKeep in mind that backslashes in the expression need to be escaped due to being encompassed in a JSON string.\n", - "example": "(?.)\\-(?.*)", + "example": "(?\u003cC0\u003e.)\\-(?\u003cM2\u003e.*)", "type": "string" }, "label": { @@ -6760,419 +7051,240 @@ } }, "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get a custom base image collection", - "tags": [ - "Custom Base Images" - ], - "x-snyk-api-releases": [ - "2023-08-21", - "2023-09-20", - "2024-01-04" - ], - "x-snyk-api-version": "2024-01-04" - }, - "post": { - "description": "In order to create a custom base image, you first need to import your base images into Snyk.\nYou can do this through the CLI, UI, or API.\n\nThis endpoint marks an image as a custom base image. This means that the image will get\nadded to the pool of images from which Snyk can recommend base image upgrades.\n\nNote, after the first image in a repository gets added, a versioning schema cannot be passed in this endpoint.\nTo update the versioning schema, the PATCH endpoint must be used.\n", - "operationId": "createCustomBaseImage", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/CustomBaseImagePostRequest" - } - } - }, - "description": "The properties used in the creation of a custom base image" - }, - "responses": { - "201": { "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/CustomBaseImageResponse" + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" } } }, - "description": "Successfully created a custom base image", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Create a Custom Base Image from an existing container project", - "tags": [ - "Custom Base Images" - ], - "x-snyk-api-releases": [ - "2023-08-21", - "2023-09-20", - "2024-01-04" - ], - "x-snyk-api-version": "2024-01-04" - }, - "x-snyk-api-resource": "custombaseimages" - }, - "/custom_base_images/{custombaseimage_id}": { - "delete": { - "description": "Delete a custom base image resource. (the related container project is unaffected)", - "operationId": "deleteCustomBaseImage", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/CustomBaseImageId" - } - ], - "responses": { - "204": { - "description": "Successfully deleted the custom base image", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, "401": { - "$ref": "#/components/responses/401" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Delete a custom base image", - "tags": [ - "Custom Base Images" - ], - "x-snyk-api-releases": [ - "2023-08-21", - "2023-09-20", - "2024-01-04" - ], - "x-snyk-api-version": "2024-01-04" - }, - "get": { - "description": "Get a custom base image", - "operationId": "getCustomBaseImage", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/CustomBaseImageId" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/CustomBaseImageResponse" - } - } - }, - "description": "Returns a custom base image", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get a custom base image", - "tags": [ - "Custom Base Images" - ], - "x-snyk-api-releases": [ - "2023-08-21", - "2023-09-20", - "2024-01-04" - ], - "x-snyk-api-version": "2024-01-04" - }, - "patch": { - "description": "Updates a custom base image's attributes", - "operationId": "updateCustomBaseImage", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/CustomBaseImageId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/CustomBaseImagePatchRequest" - } - } - }, - "description": "custom base image to be updated" - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/CustomBaseImageResponse" - } - } - }, - "description": "Returns the updated custom base image", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Update a custom base image", - "tags": [ - "Custom Base Images" - ], - "x-snyk-api-releases": [ - "2023-08-21", - "2023-09-20", - "2024-01-04" - ], - "x-snyk-api-version": "2024-01-04" - }, - "x-snyk-api-resource": "custombaseimages" - }, - "/groups/{group_id}/apps/installs": { - "get": { - "description": "Get a list of apps installed for a group.", - "operationId": "getAppInstallsForGroup", - "parameters": [ - { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "app" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Group ID", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/AppInstallData" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of apps installed for the specified group.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { "content": { "application/vnd.api+json": { "schema": { @@ -7219,6 +7331,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -7293,7 +7457,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -7354,7 +7518,7 @@ } } }, - "401": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -7401,6 +7565,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -7475,7 +7691,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -7536,7 +7752,7 @@ } } }, - "403": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -7583,6 +7799,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -7657,7 +7925,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -7718,7 +7986,7 @@ } } }, - "404": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -7765,6 +8033,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -7839,7 +8159,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -7899,20 +8219,84 @@ } } } + } + }, + "summary": "Get a custom base image collection", + "tags": [ + "Custom Base Images" + ], + "x-snyk-api-releases": [ + "2023-08-21", + "2023-09-20", + "2024-01-04" + ], + "x-snyk-api-version": "2024-01-04" + }, + "post": { + "description": "In order to create a custom base image, you first need to import your base images into Snyk.\nYou can do this through the CLI, UI, or API.\n\nThis endpoint marks an image as a custom base image. This means that the image will get\nadded to the pool of images from which Snyk can recommend base image upgrades.\n\nNote, after the first image in a repository gets added, a versioning schema cannot be passed in this endpoint.\nTo update the versioning schema, the PATCH endpoint must be used.\n", + "operationId": "createCustomBaseImage", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/CustomBaseImagePostRequest" + } + } }, - "409": { + "description": "The properties used in the creation of a custom base image" + }, + "responses": { + "201": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { + "$ref": "#/components/schemas/CustomBaseImageResponse" + } + } + }, + "description": "Successfully created a custom base image", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { "version": "1.0" } }, @@ -7947,6 +8331,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -8021,7 +8457,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -8082,7 +8518,7 @@ } } }, - "500": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -8129,6 +8565,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -8203,7 +8691,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -8263,157 +8751,8 @@ } } } - } - }, - "summary": "Get a list of apps installed for a group.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "post": { - "description": "Install a Snyk Apps to this group, the Snyk App must use unattended authentication eg client credentials.", - "operationId": "createGroupAppInstall", - "parameters": [ - { - "$ref": "#/components/parameters/Version" }, - { - "description": "Group ID", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "properties": { - "type": { - "enum": [ - "app_install" - ], - "example": "app_install", - "type": "string" - } - }, - "type": "object" - }, - "relationships": { - "additionalProperties": false, - "properties": { - "app": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "id": { - "$ref": "#/components/schemas/Uuid" - }, - "type": { - "enum": [ - "app" - ], - "example": "app", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "required": [ - "app" - ], - "type": "object" - } - }, - "required": [ - "data", - "relationships" - ], - "type": "object" - } - } - }, - "description": "App Install to be created" - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppInstallWithClient" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "The newly created app install.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -8460,6 +8799,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -8534,7 +8925,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -8595,7 +8986,7 @@ } } }, - "401": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -8642,6 +9033,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -8716,7 +9159,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -8777,7 +9220,7 @@ } } }, - "403": { + "409": { "content": { "application/vnd.api+json": { "schema": { @@ -8824,6 +9267,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -8898,7 +9393,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -8959,7 +9454,7 @@ } } }, - "404": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -9006,6 +9501,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -9080,7 +9627,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -9140,8 +9687,58 @@ } } } + } + }, + "summary": "Create a Custom Base Image from an existing container project", + "tags": [ + "Custom Base Images" + ], + "x-snyk-api-releases": [ + "2023-08-21", + "2023-09-20", + "2024-01-04" + ], + "x-snyk-api-version": "2024-01-04" + }, + "x-snyk-api-resource": "custombaseimages" + }, + "/custom_base_images/{custombaseimage_id}": { + "delete": { + "description": "Delete a custom base image resource. (the related container project is unaffected)", + "operationId": "deleteCustomBaseImage", + "parameters": [ + { + "$ref": "#/components/parameters/Version" }, - "409": { + { + "$ref": "#/components/parameters/CustomBaseImageId" + } + ], + "responses": { + "204": { + "description": "Successfully deleted the custom base image", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -9188,6 +9785,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -9262,7 +9911,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -9323,7 +9972,7 @@ } } }, - "500": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -9370,6 +10019,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -9444,7 +10145,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -9504,72 +10205,8 @@ } } } - } - }, - "summary": "Install a Snyk Apps to this group.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "app_installs" - }, - "/groups/{group_id}/apps/installs/{install_id}": { - "delete": { - "description": "Revoke app authorization for an Snyk Group with install ID.", - "operationId": "deleteGroupAppInstallByID", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Group ID", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/InstallId" - } - ], - "responses": { - "204": { - "description": "The app install has been de-authorized.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } }, - "400": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -9616,6 +10253,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -9690,7 +10379,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -9750,8 +10439,62 @@ } } } + } + }, + "summary": "Delete a custom base image", + "tags": [ + "Custom Base Images" + ], + "x-snyk-api-releases": [ + "2023-08-21", + "2023-09-20", + "2024-01-04" + ], + "x-snyk-api-version": "2024-01-04" + }, + "get": { + "description": "Get a custom base image", + "operationId": "getCustomBaseImage", + "parameters": [ + { + "$ref": "#/components/parameters/Version" }, - "401": { + { + "$ref": "#/components/parameters/CustomBaseImageId" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/CustomBaseImageResponse" + } + } + }, + "description": "Returns a custom base image", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -9798,6 +10541,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -9872,7 +10667,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -9933,7 +10728,7 @@ } } }, - "403": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -9980,188 +10775,58 @@ "format": "uuid", "type": "string" }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { + "links": { "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", "example": { - "pointer": "/data/attributes" + "about": "https://example.com/about_this_error" }, "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] } }, "type": "object" }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - } - } - }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, "meta": { "additionalProperties": true, "example": { @@ -10236,7 +10901,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -10297,7 +10962,7 @@ } } }, - "409": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -10344,6 +11009,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -10418,7 +11135,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -10479,7 +11196,7 @@ } } }, - "500": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -10526,6 +11243,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -10600,7 +11369,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -10660,144 +11429,8 @@ } } } - } - }, - "summary": "Revoke app authorization for an Snyk Group with install ID.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "app_installs" - }, - "/groups/{group_id}/apps/installs/{install_id}/secrets": { - "post": { - "description": "Manage client secret for non-interactive Snyk App installations.", - "operationId": "updateGroupAppInstallSecret", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Group ID", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/InstallId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "mode": { - "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n", - "enum": [ - "replace", - "create", - "delete" - ], - "type": "string" - }, - "secret": { - "description": "Secret to delete when using `delete` mode", - "type": "string" - } - }, - "required": [ - "mode" - ], - "type": "object" - }, - "type": { - "enum": [ - "app" - ], - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppInstallDataWithSecret" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Secret has been updated.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } }, - "400": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -10844,6 +11477,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -10918,7 +11603,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -10978,8 +11663,72 @@ } } } + } + }, + "summary": "Get a custom base image", + "tags": [ + "Custom Base Images" + ], + "x-snyk-api-releases": [ + "2023-08-21", + "2023-09-20", + "2024-01-04" + ], + "x-snyk-api-version": "2024-01-04" + }, + "patch": { + "description": "Updates a custom base image's attributes", + "operationId": "updateCustomBaseImage", + "parameters": [ + { + "$ref": "#/components/parameters/Version" }, - "401": { + { + "$ref": "#/components/parameters/CustomBaseImageId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/CustomBaseImagePatchRequest" + } + } + }, + "description": "custom base image to be updated" + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/CustomBaseImageResponse" + } + } + }, + "description": "Returns the updated custom base image", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -11026,6 +11775,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -11100,7 +11901,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -11161,7 +11962,7 @@ } } }, - "403": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -11208,6 +12009,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -11282,7 +12135,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -11343,7 +12196,7 @@ } } }, - "404": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -11390,6 +12243,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -11464,7 +12369,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -11525,7 +12430,7 @@ } } }, - "409": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -11572,6 +12477,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -11646,7 +12603,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -11754,6 +12711,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -11890,55 +12899,54 @@ } } }, - "summary": "Manage client secret for non-interactive Snyk App installations.", + "summary": "Update a custom base image", "tags": [ - "Apps" + "Custom Base Images" ], "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" + "2023-08-21", + "2023-09-20", + "2024-01-04" ], - "x-snyk-api-version": "2023-11-03" + "x-snyk-api-version": "2024-01-04" }, - "x-snyk-api-resource": "app_installs" + "x-snyk-api-resource": "custombaseimages" }, - "/groups/{group_id}/audit_logs/search": { + "/groups/{group_id}/apps/installs": { "get": { - "description": "Search audit logs for a Group. \"api.access\" events are omitted from results unless explicitly requested using the events parameter. Some Organization level events are supported as well as the following\nGroup level events:\n - api.access\n - group.cloud_config.settings.edit\n - group.create\n - group.delete\n - group.edit\n - group.notification_settings.edit\n - group.org.add\n - group.org.remove\n - group.policy.create\n - group.policy.delete\n - group.policy.edit\n - group.request_access_settings.edit\n - group.role.create\n - group.role.delete\n - group.role.edit\n - group.service_account.create\n - group.service_account.delete\n - group.service_account.edit\n - group.settings.edit\n - group.settings.feature_flag.edit\n - group.sso.add\n - group.sso.auth0_connection.create\n - group.sso.auth0_connection.edit\n - group.sso.create\n - group.sso.delete\n - group.sso.edit\n - group.sso.membership.sync\n - group.sso.remove\n - group.tag.create\n - group.tag.delete\n - group.user.add\n - group.user.remove\n - group.user.role.edit\n", - "operationId": "listGroupAuditLogs", + "description": "Get a list of apps installed for a group.", + "operationId": "getAppInstallsForGroup", "parameters": [ { - "$ref": "#/components/parameters/Version" + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "app" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" }, { "$ref": "#/components/parameters/GroupId" }, { - "$ref": "#/components/parameters/Cursor" - }, - { - "$ref": "#/components/parameters/From" - }, - { - "$ref": "#/components/parameters/To" - }, - { - "$ref": "#/components/parameters/Size" - }, - { - "$ref": "#/components/parameters/SortOrder" - }, - { - "$ref": "#/components/parameters/UserId" + "$ref": "#/components/parameters/Version" }, { - "$ref": "#/components/parameters/ProjectId" + "$ref": "#/components/parameters/StartingAfter" }, { - "$ref": "#/components/parameters/Events" + "$ref": "#/components/parameters/EndingBefore" }, { - "$ref": "#/components/parameters/ExcludeEvents" + "$ref": "#/components/parameters/Limit" } ], "responses": { @@ -11949,33 +12957,32 @@ "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/AuditLogSearch" + "items": { + "$ref": "#/components/schemas/AppInstallData" + }, + "type": "array" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/Links" + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "data" + "links" ], "type": "object" } } }, - "description": "Group Audit Logs.", + "description": "A list of apps installed for the specified group.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, - "location": { - "schema": { - "type": "string" - } - }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -12005,269 +13012,511 @@ "404": { "$ref": "#/components/responses/404" }, + "409": { + "$ref": "#/components/responses/409" + }, "500": { "$ref": "#/components/responses/500" } }, - "summary": "Search Group audit logs.", + "summary": "Get a list of apps installed for a group.", "tags": [ - "Audit Logs" + "Apps" ], "x-snyk-api-releases": [ - "2023-09-11", - "2024-04-29" + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" ], - "x-snyk-api-version": "2024-04-29" + "x-snyk-api-version": "2024-05-23" }, - "x-snyk-api-resource": "audit-logs", - "x-snyk-resource-singleton": true - }, - "/groups/{group_id}/issues": { - "get": { - "description": "Get a list of a group's issues.", - "operationId": "listGroupIssues", + "post": { + "description": "Install a Snyk Apps to this group, the Snyk App must use unattended authentication eg client credentials.", + "operationId": "createGroupAppInstall", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "description": "Group ID", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "example": "4a18d42f-0706-4ad0-b127-24078731fbed", - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ScanItemId" - }, - { - "$ref": "#/components/parameters/ScanItemType" - }, - { - "$ref": "#/components/parameters/Type" - }, - { - "$ref": "#/components/parameters/UpdatedBefore" - }, - { - "$ref": "#/components/parameters/UpdatedAfter" - }, - { - "$ref": "#/components/parameters/CreatedBefore" - }, - { - "$ref": "#/components/parameters/CreatedAfter" - }, - { - "$ref": "#/components/parameters/EffectiveSeverityLevel" - }, - { - "$ref": "#/components/parameters/Status" - }, - { - "$ref": "#/components/parameters/Ignored" + "$ref": "#/components/parameters/GroupId" } ], - "responses": { - "200": { - "$ref": "#/components/responses/ListIssues200" - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "properties": { + "type": { + "enum": [ + "app_install" + ], + "example": "app_install", + "type": "string" } - ], - "jsonapi": { - "version": "1.0" - } + }, + "type": "object" }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { + "relationships": { + "additionalProperties": false, + "properties": { + "app": { "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { + "data": { "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" + "id": { + "$ref": "#/components/schemas/Uuid" }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", + "type": { + "enum": [ + "app" + ], + "example": "app", "type": "string" } }, + "required": [ + "id", + "type" + ], "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" } }, "required": [ - "status", - "detail" + "data" ], "type": "object" - }, - "minItems": 1, - "type": "array" + } + }, + "required": [ + "app" + ], + "type": "object" + } + }, + "required": [ + "data", + "relationships" + ], + "type": "object" + } + } + }, + "description": "App Install to be created" + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/AppInstallWithClient" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "The newly created app install.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date-time", "type": "string" } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Install a Snyk Apps to this group.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-version": "2024-05-23" + }, + "x-snyk-api-resource": "app_installs" + }, + "/groups/{group_id}/apps/installs/{install_id}": { + "delete": { + "description": "Revoke app authorization for an Snyk Group with install ID.", + "operationId": "deleteGroupAppInstallById", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/GroupId" + }, + { + "$ref": "#/components/parameters/InstallId" + } + ], + "responses": { + "204": { + "description": "The app install has been de-authorized.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "schema": { + "type": "string" + } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Revoke app authorization for an Snyk Group with install ID.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-version": "2024-05-23" + }, + "x-snyk-api-resource": "app_installs" + }, + "/groups/{group_id}/apps/installs/{install_id}/secrets": { + "post": { + "description": "Manage client secret for non-interactive Snyk App installations.", + "operationId": "updateGroupAppInstallSecret", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/GroupId" + }, + { + "$ref": "#/components/parameters/InstallId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "additionalProperties": false, + "properties": { + "mode": { + "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n", + "enum": [ + "replace", + "create", + "delete" + ], + "type": "string" + }, + "secret": { + "description": "Secret to delete when using `delete` mode", + "type": "string" + } + }, + "required": [ + "mode" + ], + "type": "object" + }, + "type": { + "enum": [ + "app" + ], + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/AppInstallDataWithSecret" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" + } + }, + "type": "object" + } + } + }, + "description": "Secret has been updated.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "schema": { + "type": "string" + } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Manage client secret for non-interactive Snyk App installations.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-version": "2024-05-23" + }, + "x-snyk-api-resource": "app_installs" + }, + "/groups/{group_id}/audit_logs/search": { + "get": { + "description": "Search audit logs for a Group. \"api.access\" events are omitted from results unless explicitly requested using the events parameter. Some Organization level events are supported as well as the following\nGroup level events:\n - api.access\n - group.cloud_config.settings.edit\n - group.create\n - group.delete\n - group.edit\n - group.notification_settings.edit\n - group.org.add\n - group.org.remove\n - group.policy.create\n - group.policy.delete\n - group.policy.edit\n - group.request_access_settings.edit\n - group.role.create\n - group.role.delete\n - group.role.edit\n - group.service_account.create\n - group.service_account.delete\n - group.service_account.edit\n - group.settings.edit\n - group.settings.feature_flag.edit\n - group.sso.add\n - group.sso.auth0_connection.create\n - group.sso.auth0_connection.edit\n - group.sso.create\n - group.sso.delete\n - group.sso.edit\n - group.sso.membership.sync\n - group.sso.remove\n - group.tag.create\n - group.tag.delete\n - group.user.add\n - group.user.remove\n - group.user.role.edit\n", + "operationId": "listGroupAuditLogs", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The ID of the Group.", + "example": "0d3728ec-eebf-484d-9907-ba238019f10b", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Cursor" + }, + { + "$ref": "#/components/parameters/From" + }, + { + "$ref": "#/components/parameters/To" + }, + { + "$ref": "#/components/parameters/Size" + }, + { + "$ref": "#/components/parameters/SortOrder" + }, + { + "$ref": "#/components/parameters/UserId" + }, + { + "$ref": "#/components/parameters/ProjectId" + }, + { + "$ref": "#/components/parameters/Events" + }, + { + "$ref": "#/components/parameters/ExcludeEvents" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/AuditLogSearch" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data" + ], + "type": "object" + } + } + }, + "description": "Group Audit Logs.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "schema": { + "type": "string" + } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -12314,6 +13563,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -12388,7 +13689,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -12449,7 +13750,7 @@ } } }, - "404": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -12496,6 +13797,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -12570,7 +13923,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -12631,7 +13984,7 @@ } } }, - "500": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -12678,6 +14031,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -12752,7 +14157,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -12812,49 +14217,8 @@ } } } - } - }, - "summary": "Get issues by group ID", - "tags": [ - "Issues" - ], - "x-snyk-api-releases": [ - "2023-03-10~experimental", - "2023-09-29~beta", - "2024-01-23" - ], - "x-snyk-api-version": "2024-01-23" - }, - "x-snyk-api-resource": "issues" - }, - "/groups/{group_id}/issues/{issue_id}": { - "get": { - "description": "Get an issue", - "operationId": "getGroupIssueByIssueID", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Group ID", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "example": "4a18d42f-0706-4ad0-b127-24078731fbed", - "format": "uuid", - "type": "string" - } }, - { - "$ref": "#/components/parameters/PathIssueId" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/GetIssue200" - }, - "400": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -12901,6 +14265,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -12975,7 +14391,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -13036,7 +14452,7 @@ } } }, - "401": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -13083,6 +14499,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -13157,7 +14625,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -13217,6 +14685,86 @@ } } } + } + }, + "summary": "Search Group audit logs.", + "tags": [ + "Audit Logs" + ], + "x-snyk-api-releases": [ + "2023-09-11", + "2024-04-29" + ], + "x-snyk-api-version": "2024-04-29" + }, + "x-snyk-api-resource": "audit-logs", + "x-snyk-resource-singleton": true + }, + "/groups/{group_id}/issues": { + "get": { + "description": "Get a list of a group's issues.", + "operationId": "listGroupIssues", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "description": "Group ID", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "example": "4a18d42f-0706-4ad0-b127-24078731fbed", + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/ScanItemId" + }, + { + "$ref": "#/components/parameters/ScanItemType" + }, + { + "$ref": "#/components/parameters/Type" + }, + { + "$ref": "#/components/parameters/UpdatedBefore" + }, + { + "$ref": "#/components/parameters/UpdatedAfter" + }, + { + "$ref": "#/components/parameters/CreatedBefore" + }, + { + "$ref": "#/components/parameters/CreatedAfter" + }, + { + "$ref": "#/components/parameters/EffectiveSeverityLevel" + }, + { + "$ref": "#/components/parameters/Status" + }, + { + "$ref": "#/components/parameters/Ignored" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ListIssues200" + }, + "401": { + "$ref": "#/components/responses/401" }, "403": { "content": { @@ -13401,6 +14949,59 @@ } }, "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get issues by group ID", + "tags": [ + "Issues" + ], + "x-snyk-api-releases": [ + "2023-03-10~experimental", + "2023-09-29~beta", + "2024-01-23" + ], + "x-snyk-api-version": "2024-01-23" + }, + "x-snyk-api-resource": "issues" + }, + "/groups/{group_id}/issues/{issue_id}": { + "get": { + "description": "Get an issue", + "operationId": "getGroupIssueByIssueID", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Group ID", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "example": "4a18d42f-0706-4ad0-b127-24078731fbed", + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/PathIssueId" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/GetIssue200" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -13521,7 +15122,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -13582,7 +15183,106 @@ } } }, + "404": { + "$ref": "#/components/responses/404" + }, "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get an issue", + "tags": [ + "Issues" + ], + "x-snyk-api-releases": [ + "2024-01-23" + ], + "x-snyk-api-version": "2024-01-23" + }, + "x-snyk-api-resource": "issues" + }, + "/groups/{group_id}/orgs": { + "get": { + "description": "Get a paginated list of all the organizations belonging to the group.\nBy default, this endpoint returns the organizations in alphabetical order of their name.", + "operationId": "listOrgsInGroup", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/PathGroupId" + }, + { + "$ref": "#/components/parameters/QueryNameFilter" + }, + { + "$ref": "#/components/parameters/QuerySlugFilter" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/Org" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "A list of organizations in the group.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -13629,6 +15329,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -13703,7 +15455,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -13764,7 +15516,7 @@ } } }, - "500": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -13811,6 +15563,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -13885,7 +15689,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -13945,271 +15749,62 @@ } } } - } - }, - "summary": "Get an issue", - "tags": [ - "Issues" - ], - "x-snyk-api-releases": [ - "2024-01-23" - ], - "x-snyk-api-version": "2024-01-23" - }, - "x-snyk-api-resource": "issues" - }, - "/groups/{group_id}/orgs": { - "get": { - "description": "Get a paginated list of all the organizations belonging to the group.\nBy default, this endpoint returns the organizations in alphabetical order of their name.", - "operationId": "listOrgsInGroup", - "parameters": [ - { - "$ref": "#/components/parameters/Version" }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "$ref": "#/components/parameters/PathGroupId" - }, - { - "$ref": "#/components/parameters/QueryNameFilter" - }, - { - "$ref": "#/components/parameters/QuerySlugFilter" - } - ], - "responses": { - "200": { + "403": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/Org" - }, - "type": "array" - }, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" + "version": "1.0" } }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of organizations in the group.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "List all organizations in group", - "tags": [ - "Orgs" - ], - "x-snyk-api-releases": [ - "2023-10-24~experimental", - "2023-12-14~beta", - "2024-02-28" - ], - "x-snyk-api-version": "2024-02-28" - }, - "x-snyk-api-resource": "orgs" - }, - "/groups/{group_id}/service_accounts": { - "get": { - "description": "Get all service accounts for a group.", - "operationId": "getManyGroupServiceAccount", - "parameters": [ - { - "description": "The ID of the Snyk Group that owns the service accounts.", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, "properties": { - "data": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], "items": { "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, "properties": { - "attributes": { - "properties": { - "access_token_ttl_seconds": { - "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", - "type": "number" - }, - "api_key": { - "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", - "type": "string" - }, - "auth_type": { - "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", - "enum": [ - "api_key", - "oauth_client_secret", - "oauth_private_key_jwt" - ], - "type": "string" - }, - "client_id": { - "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "client_secret": { - "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", - "type": "string" - }, - "jwks_url": { - "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "level": { - "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", - "enum": [ - "Group", - "Org" - ], - "type": "string" - }, - "name": { - "description": "A human-friendly name of the service account.", - "type": "string" - }, - "role_id": { - "description": "The ID of the role which the Service Account is associated with.", - "format": "uuid", - "type": "string" - } - }, - "required": [ - "name", - "auth_type", - "role_id" - ], - "type": "object" + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" }, "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string" }, "links": { "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, "properties": { - "first": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "last": { + "about": { "example": "https://example.com/api/resource", "oneOf": [ { @@ -14250,50 +15845,200 @@ "type": "object" } ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" }, - "next": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "prev": { + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { "example": "https://example.com/api/resource", "oneOf": [ { @@ -14334,8 +16079,200 @@ "type": "object" } ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" }, - "related": { + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { "example": "https://example.com/api/resource", "oneOf": [ { @@ -14376,137 +16313,166 @@ "type": "object" } ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" }, - "self": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" } }, "type": "object" }, - "type": { + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", "type": "string" } }, "required": [ - "type", - "id", - "attributes" + "status", + "detail" ], "type": "object" }, + "minItems": 1, "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "A list of service accounts is returned.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" } }, - "summary": "Get a list of group service accounts.", + "summary": "List all organizations in group", "tags": [ - "ServiceAccounts" + "Orgs" ], "x-snyk-api-releases": [ - "2023-09-07" + "2023-10-24~experimental", + "2023-12-14~beta", + "2024-02-28" ], - "x-snyk-api-version": "2023-09-07" + "x-snyk-api-version": "2024-02-28" }, - "post": { - "description": "Create a service account for a group. The service account can be used to generate access tokens. Currently, we only allow group service accounts using default group roles.", - "operationId": "createGroupServiceAccount", + "x-snyk-api-resource": "orgs" + }, + "/groups/{group_id}/service_accounts": { + "get": { + "description": "Get all service accounts for a group.", + "operationId": "getManyGroupServiceAccount", "parameters": [ { - "description": "The ID of the Snyk Group that is creating and owns the service account", + "description": "The ID of the Snyk Group that owns the service accounts.", "in": "path", "name": "group_id", "required": true, @@ -14515,1515 +16481,1600 @@ "type": "string" } }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, { "$ref": "#/components/parameters/Version" } ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "items": { "additionalProperties": false, "properties": { - "access_token_ttl_seconds": { - "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1 hour if unset. Only used when auth_type is one of the oauth_* variants.", - "maximum": 86400, - "minimum": 3600, - "type": "number" - }, - "auth_type": { - "description": "Authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out in OIDC Connect Core 1.0, section 9.", - "enum": [ - "api_key", - "oauth_client_secret", - "oauth_private_key_jwt" + "attributes": { + "properties": { + "access_token_ttl_seconds": { + "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", + "type": "number" + }, + "api_key": { + "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", + "type": "string" + }, + "auth_type": { + "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", + "enum": [ + "api_key", + "oauth_client_secret", + "oauth_private_key_jwt" + ], + "type": "string" + }, + "client_id": { + "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_client_secret or oauth_private_key_jwt.", + "type": "string" + }, + "client_secret": { + "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", + "type": "string" + }, + "jwks_url": { + "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", + "type": "string" + }, + "level": { + "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", + "enum": [ + "Group", + "Org" + ], + "type": "string" + }, + "name": { + "description": "A human-friendly name of the service account.", + "type": "string" + }, + "role_id": { + "description": "The ID of the role which the Service Account is associated with.", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "name", + "auth_type", + "role_id" ], - "type": "string" + "type": "object" }, - "jwks_url": { - "description": "A JWKs URL hosting your public keys, used to verify signed JWT requests. Must be https. Required only when auth_type is oauth_private_key_jwt.", + "id": { + "format": "uuid", "type": "string" }, - "name": { - "description": "A human-friendly name for the service account.", - "type": "string" + "links": { + "additionalProperties": false, + "properties": { + "first": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "last": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "next": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "prev": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "related": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "self": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" }, - "role_id": { - "description": "The ID of the role which the created service account should use.", - "format": "uuid", + "type": { "type": "string" } }, "required": [ - "name", - "auth_type", - "role_id" + "type", + "id", + "attributes" ], "type": "object" }, - "type": { - "description": "The Resource type.", - "enum": [ - "service_account" - ], - "type": "string" - } + "type": "array" }, - "required": [ - "type", - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "A list of service accounts is returned.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" } } }, - "required": true - }, - "responses": { - "201": { + "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "properties": { - "access_token_ttl_seconds": { - "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", - "type": "number" - }, - "api_key": { - "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", - "type": "string" - }, - "auth_type": { - "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", - "enum": [ - "api_key", - "oauth_client_secret", - "oauth_private_key_jwt" - ], - "type": "string" - }, - "client_id": { - "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "client_secret": { - "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", - "type": "string" - }, - "jwks_url": { - "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "level": { - "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", - "enum": [ - "Group", - "Org" - ], - "type": "string" - }, - "name": { - "description": "A human-friendly name of the service account.", - "type": "string" - }, - "role_id": { - "description": "The ID of the role which the Service Account is associated with.", - "format": "uuid", - "type": "string" - } - }, - "required": [ - "name", - "auth_type", - "role_id" - ], - "type": "object" - }, - "id": { - "format": "uuid", - "type": "string" + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" }, - "links": { - "additionalProperties": false, - "properties": { - "first": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" }, - "last": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "next": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "prev": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" + "type": "object" + } }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "required": [ + "href" + ], + "type": "object" + } + ] + } }, - "related": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" }, - "self": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - } + "type": "object" }, - "type": "object" + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } }, - "type": { + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string" } }, "required": [ - "type", - "id", - "attributes" + "version" ], "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "data" + "errors" ], "type": "object" } } }, - "description": "A new service account has been created", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Create a service account for a group.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "x-snyk-api-resource": "service_accounts" - }, - "/groups/{group_id}/service_accounts/{serviceaccount_id}": { - "delete": { - "description": "Permanently delete a group-level service account by its ID.", - "operationId": "deleteOneGroupServiceAccount", - "parameters": [ - { - "description": "The ID of the Snyk Group that owns the service account.", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the service account.", - "in": "path", - "name": "serviceaccount_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } } }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "204": { - "description": "Service account was successfully deleted.", + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Delete a group service account.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "get": { - "description": "Get a group-level service account by its ID.", - "operationId": "getOneGroupServiceAccount", - "parameters": [ - { - "description": "The ID of the Snyk Group that owns the service account.", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the service account.", - "in": "path", - "name": "serviceaccount_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "properties": { - "access_token_ttl_seconds": { - "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", - "type": "number" - }, - "api_key": { - "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", - "type": "string" - }, - "auth_type": { - "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", - "enum": [ - "api_key", - "oauth_client_secret", - "oauth_private_key_jwt" - ], - "type": "string" - }, - "client_id": { - "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" }, - "client_secret": { - "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", - "type": "string" + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } }, - "jwks_url": { - "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" }, - "level": { - "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", - "enum": [ - "Group", - "Org" - ], - "type": "string" + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" }, - "name": { - "description": "A human-friendly name of the service account.", - "type": "string" + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } }, - "role_id": { - "description": "The ID of the role which the Service Account is associated with.", - "format": "uuid", - "type": "string" - } + "type": "object" }, - "required": [ - "name", - "auth_type", - "role_id" - ], - "type": "object" + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } }, - "id": { - "format": "uuid", - "type": "string" - }, - "links": { - "additionalProperties": false, - "properties": { - "first": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "last": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "next": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "prev": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "related": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "self": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - } - }, - "type": "object" - }, - "type": { + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string" } }, "required": [ - "type", - "id", - "attributes" + "version" ], "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "Service account is returned.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get a group service account.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "patch": { - "description": "Update the name of a group's service account by its ID.", - "operationId": "updateGroupServiceAccount", - "parameters": [ - { - "description": "The ID of the Snyk Group that owns the service account.", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the service account.", - "in": "path", - "name": "serviceaccount_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "name": { - "description": "A human-friendly name for the service account. Must be unique within the group.", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "id": { - "description": "The ID of the service account. Must match the id in the url path.", - "format": "uuid", - "type": "string" - }, - "type": { - "description": "The Resource type.", - "enum": [ - "service_account" - ], - "type": "string" - } - }, - "required": [ - "type", - "id", - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "properties": { - "access_token_ttl_seconds": { - "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", - "type": "number" - }, - "api_key": { - "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", - "type": "string" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" }, - "auth_type": { - "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", - "enum": [ - "api_key", - "oauth_client_secret", - "oauth_private_key_jwt" - ], - "type": "string" - }, - "client_id": { - "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "client_secret": { - "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", - "type": "string" - }, - "jwks_url": { - "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "level": { - "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", - "enum": [ - "Group", - "Org" - ], - "type": "string" - }, - "name": { - "description": "A human-friendly name of the service account.", - "type": "string" - }, - "role_id": { - "description": "The ID of the role which the Service Account is associated with.", - "format": "uuid", - "type": "string" - } - }, - "required": [ - "name", - "auth_type", - "role_id" - ], - "type": "object" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "links": { - "additionalProperties": false, - "properties": { - "first": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "last": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "next": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" + "type": "object" + } }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "required": [ + "href" + ], + "type": "object" + } + ] + } }, - "prev": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" }, - "related": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" }, - "self": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - } + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" }, - "type": "object" + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } }, - "type": { + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string" } }, "required": [ - "type", - "id", - "attributes" + "version" ], "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "Service account is returned.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Update a group service account.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "x-snyk-api-resource": "service_accounts" - }, - "/groups/{group_id}/service_accounts/{serviceaccount_id}/secrets": { - "post": { - "description": "Manage the client secret of a group service account by the service account ID.", - "operationId": "updateServiceAccountSecret", - "parameters": [ - { - "description": "The ID of the Snyk Group that owns the service account.", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the service account.", - "in": "path", - "name": "serviceaccount_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Get a list of group service accounts.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-version": "2023-09-07" + }, + "post": { + "description": "Create a service account for a group. The service account can be used to access the Snyk API.", + "operationId": "createGroupServiceAccount", + "parameters": [ + { + "description": "The ID of the Snyk Group that is creating and owns the service account", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], "requestBody": { "content": { "application/vnd.api+json": { @@ -16036,22 +18087,39 @@ "attributes": { "additionalProperties": false, "properties": { - "mode": { - "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated secret.\n * `create` - Add a new secret, preserving existing secrets. A maximum of to two secrets can exist at a time.\n * `delete` - Remove an existing secret by value. At least one secret must remain per service account.\n", + "access_token_ttl_seconds": { + "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1 hour if unset. Only used when auth_type is one of the oauth_* variants.", + "maximum": 86400, + "minimum": 3600, + "type": "number" + }, + "auth_type": { + "description": "Authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out in OIDC Connect Core 1.0, section 9.", "enum": [ - "replace", - "create", - "delete" + "api_key", + "oauth_client_secret", + "oauth_private_key_jwt" ], "type": "string" }, - "secret": { - "description": "Secret to delete when using `delete` mode", + "jwks_url": { + "description": "A JWKs URL hosting your public keys, used to verify signed JWT requests. Must be https. Required only when auth_type is oauth_private_key_jwt.", + "type": "string" + }, + "name": { + "description": "A human-friendly name for the service account.", + "type": "string" + }, + "role_id": { + "description": "The ID of the role which the created service account should use.", + "format": "uuid", "type": "string" } }, "required": [ - "mode" + "name", + "auth_type", + "role_id" ], "type": "object" }, @@ -16064,8 +18132,8 @@ } }, "required": [ - "attributes", - "type" + "type", + "attributes" ], "type": "object" } @@ -16080,7 +18148,7 @@ "required": true }, "responses": { - "200": { + "201": { "content": { "application/vnd.api+json": { "schema": { @@ -16109,7 +18177,7 @@ "type": "string" }, "client_id": { - "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt.", + "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_client_secret or oauth_private_key_jwt.", "type": "string" }, "client_secret": { @@ -16433,7 +18501,7 @@ } } }, - "description": "Service account client secret has been updated.", + "description": "A new service account has been created", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" @@ -16459,813 +18527,474 @@ } }, "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Manage a group service account's client secret.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "x-snyk-api-resource": "service_accounts" - }, - "/groups/{group_id}/settings/iac": { - "get": { - "description": "Get the Infrastructure as Code Settings for a group.", - "operationId": "getIacSettingsForGroup", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the group whose Infrastructure as Code settings are requested", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "$ref": "#/components/schemas/GroupIacSettingsResponse" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "The Infrastructure as Code Settings of the group.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get the Infrastructure as Code Settings for a group", - "tags": [ - "IacSettings" - ], - "x-snyk-api-releases": [ - "2021-12-09" - ], - "x-snyk-api-version": "2021-12-09" - }, - "patch": { - "description": "Update the Infrastructure as Code Settings for a group.", - "operationId": "updateIacSettingsForGroup", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the group whose Infrastructure as Code settings are getting updated", - "in": "path", - "name": "group_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "$ref": "#/components/schemas/GroupIacSettingsRequest" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "$ref": "#/components/schemas/GroupIacSettingsResponse" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "The Infrastructure as Code Settings of the group were updated.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Update the Infrastructure as Code Settings for a group", - "tags": [ - "IacSettings" - ], - "x-snyk-api-releases": [ - "2021-12-09" - ], - "x-snyk-api-version": "2021-12-09" - }, - "x-snyk-api-resource": "iac_settings" - }, - "/openapi": { - "get": { - "description": "List available versions of OpenAPI specification", - "operationId": "listAPIVersions", - "responses": { - "200": { - "content": { - "application/json": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", "schema": { - "items": { - "type": "string" - }, - "type": "array" + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" } - } - }, - "description": "List of available versions is returned", - "headers": { - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "tags": [ - "OpenAPI" - ] - } - }, - "/openapi/{version}": { - "get": { - "description": "Get OpenAPI specification effective at version.", - "operationId": "getAPIVersion", - "parameters": [ - { - "description": "The requested version of the API", - "in": "path", - "name": "version", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", "schema": { - "type": "object" + "format": "date-time", + "type": "string" } } - }, - "description": "OpenAPI specification matching requested version is returned", - "headers": { - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "tags": [ - "OpenAPI" - ] - } - }, - "/orgs": { - "get": { - "description": "Get a paginated list of organizations you have access to.", - "operationId": "listOrgs", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "description": "If set, only return organizations within the specified group", - "in": "query", - "name": "group_id", - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "If true, only return organizations that are not part of a group.", - "in": "query", - "name": "is_personal", - "schema": { - "type": "boolean" - } - }, - { - "description": "Only return orgs whose slug exactly matches this value.", - "in": "query", - "name": "slug", - "schema": { - "maxLength": 100, - "pattern": "^[\\w.-]+$", - "type": "string" - } - }, - { - "description": "Only return orgs whose name contains this value.", - "in": "query", - "name": "name", - "schema": { - "maxLength": 100, - "type": "string" - } - }, - { - "description": "Expand the specified related resources in the response to include their attributes.", - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "member_role" - ], - "type": "string" - }, - "type": "array" - } - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/OrgWithRelationships" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of organizations you have access to.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "List accessible organizations", - "tags": [ - "Orgs" - ], - "x-snyk-api-releases": [ - "2022-04-06~experimental", - "2022-12-15~beta", - "2023-05-29", - "2024-02-28" - ], - "x-snyk-api-version": "2024-02-28" - }, - "x-snyk-api-resource": "orgs" - }, - "/orgs/{org_id}": { - "get": { - "description": "Get the full details of an organization.", - "operationId": "getOrg", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Unique identifier for org", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "example": "b667f176-df52-4b0a-9954-117af6b05ab7", - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "$ref": "#/components/schemas/Org" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Returns an instance of an organization", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get organization", - "tags": [ - "Orgs" - ], - "x-snyk-api-releases": [ - "2022-04-06~experimental", - "2022-12-15~beta", - "2023-05-29" - ], - "x-snyk-api-version": "2023-05-29" - }, - "patch": { - "description": "Update the details of an organization", - "operationId": "updateOrg", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Unique identifier for org", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "example": "b667f176-df52-4b0a-9954-117af6b05ab7", - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "$ref": "#/components/schemas/OrgUpdateAttributes" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "type": { - "$ref": "#/components/schemas/Types" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "additionalProperties": false, - "description": "org resource object", - "properties": { - "attributes": { - "$ref": "#/components/schemas/OrgAttributes" - }, - "id": { - "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", - "format": "uuid", - "type": "string" - }, - "relationships": { - "$ref": "#/components/schemas/OrgRelationships" - }, - "type": { - "$ref": "#/components/schemas/Types" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Instance of org is updated", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "204": { - "$ref": "#/components/responses/204" - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Update organization", - "tags": [ - "Orgs" - ], - "x-snyk-api-releases": [ - "2022-04-06~experimental", - "2022-12-15~beta", - "2023-05-29" - ], - "x-snyk-api-version": "2023-05-29" - }, - "x-snyk-api-resource": "orgs" - }, - "/orgs/{org_id}/app_bots": { - "get": { - "deprecated": true, - "description": "Get a list of app bots authorized to an organization. Deprecated, use /orgs/{org_id}/apps/installs instead.", - "operationId": "getAppBots", - "parameters": [ - { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "app" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/AppBot" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of app bots authorized to the specified organization", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { "content": { "application/vnd.api+json": { "schema": { @@ -17312,6 +19041,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -17386,7 +19167,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -17447,7 +19228,7 @@ } } }, - "401": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -17494,54 +19275,106 @@ "format": "uuid", "type": "string" }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { + "links": { "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", "example": { - "pointer": "/data/attributes" + "about": "https://example.com/about_this_error" }, "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { "additionalProperties": false, "example": { "version": "1.0" @@ -17568,7 +19401,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -17628,8 +19461,76 @@ } } } + } + }, + "summary": "Create a service account for a group.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-version": "2023-09-07" + }, + "x-snyk-api-resource": "service_accounts" + }, + "/groups/{group_id}/service_accounts/{serviceaccount_id}": { + "delete": { + "description": "Permanently delete a group-level service account by its ID.", + "operationId": "deleteOneGroupServiceAccount", + "parameters": [ + { + "description": "The ID of the Snyk Group that owns the service account.", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, - "403": { + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "204": { + "description": "Service account was successfully deleted.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -17676,6 +19577,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -17750,7 +19703,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -17811,7 +19764,7 @@ } } }, - "404": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -17858,6 +19811,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -17932,7 +19937,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -17993,7 +19998,7 @@ } } }, - "409": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -18040,6 +20045,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -18114,7 +20171,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -18175,7 +20232,7 @@ } } }, - "500": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -18222,260 +20279,58 @@ "format": "uuid", "type": "string" }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { + "links": { "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", "example": { - "pointer": "/data/attributes" + "about": "https://example.com/about_this_error" }, "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] } }, "type": "object" }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - } - } - } - }, - "summary": "Get a list of app bots authorized to an organization.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2022-03-11" - ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" - }, - "x-snyk-api-resource": "app_bots" - }, - "/orgs/{org_id}/app_bots/{bot_id}": { - "delete": { - "deprecated": true, - "description": "Revoke app bot authorization. Deprecated, use /orgs/{org_id}/apps/installs/{install_id} instead.", - "operationId": "deleteAppBot", - "parameters": [ - { - "description": "The ID of the app bot", - "in": "path", - "name": "bot_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The app bot has been deauthorized", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, "meta": { "additionalProperties": true, "example": { @@ -18550,7 +20405,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -18611,7 +20466,7 @@ } } }, - "401": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -18658,6 +20513,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -18732,7 +20639,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -18792,190 +20699,426 @@ } } } + } + }, + "summary": "Delete a group service account.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-version": "2023-09-07" + }, + "get": { + "description": "Get a group-level service account by its ID.", + "operationId": "getOneGroupServiceAccount", + "parameters": [ + { + "description": "The ID of the Snyk Group that owns the service account.", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, - "403": { + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "properties": { + "access_token_ttl_seconds": { + "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", + "type": "number" }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" + "api_key": { + "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", + "type": "string" }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } + "auth_type": { + "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", + "enum": [ + "api_key", + "oauth_client_secret", + "oauth_private_key_jwt" + ], + "type": "string" }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" + "client_id": { + "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_client_secret or oauth_private_key_jwt.", + "type": "string" + }, + "client_secret": { + "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", + "type": "string" + }, + "jwks_url": { + "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", + "type": "string" + }, + "level": { + "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", + "enum": [ + "Group", + "Org" + ], + "type": "string" + }, + "name": { + "description": "A human-friendly name of the service account.", + "type": "string" + }, + "role_id": { + "description": "The ID of the role which the Service Account is associated with.", + "format": "uuid", + "type": "string" + } }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } + "required": [ + "name", + "auth_type", + "role_id" + ], + "type": "object" }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "id": { + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "properties": { + "first": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "last": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "next": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "prev": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "related": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "self": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "type": { "type": "string" } }, "required": [ - "version" + "type", + "id", + "attributes" ], "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Service account is returned.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, - "404": { + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -19022,6 +21165,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -19096,7 +21291,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -19157,7 +21352,7 @@ } } }, - "409": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -19204,6 +21399,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -19278,7 +21525,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -19339,7 +21586,7 @@ } } }, - "500": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -19386,6 +21633,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -19460,7 +21759,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -19520,101 +21819,8 @@ } } } - } - }, - "summary": "Revoke app bot authorization", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2022-03-11" - ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" - }, - "x-snyk-api-resource": "app_bots" - }, - "/orgs/{org_id}/apps": { - "get": { - "deprecated": true, - "description": "Get a list of apps created by an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.", - "operationId": "getApps", - "parameters": [ - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/AppData" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of apps created by the specified organization", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } }, - "400": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -19661,6 +21867,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -19735,7 +21993,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -19796,7 +22054,7 @@ } } }, - "401": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -19843,6 +22101,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -19917,7 +22227,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -19977,372 +22287,478 @@ } } } + } + }, + "summary": "Get a group service account.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-version": "2023-09-07" + }, + "patch": { + "description": "Update the name of a group's service account by its ID.", + "operationId": "updateGroupServiceAccount", + "parameters": [ + { + "description": "The ID of the Snyk Group that owns the service account.", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, - "403": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", + "name": { + "description": "A human-friendly name for the service account. Must be unique within the group.", "type": "string" } }, "required": [ - "status", - "detail" + "name" ], "type": "object" }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } + "id": { + "description": "The ID of the service account. Must match the id in the url path.", + "format": "uuid", + "type": "string" }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "type": { + "description": "The Resource type.", + "enum": [ + "service_account" + ], + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" } } }, - "404": { + "required": true + }, + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "properties": { + "access_token_ttl_seconds": { + "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", + "type": "number" }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" + "api_key": { + "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", + "type": "string" }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } + "auth_type": { + "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", + "enum": [ + "api_key", + "oauth_client_secret", + "oauth_private_key_jwt" + ], + "type": "string" }, - "type": "object" + "client_id": { + "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_client_secret or oauth_private_key_jwt.", + "type": "string" + }, + "client_secret": { + "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", + "type": "string" + }, + "jwks_url": { + "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", + "type": "string" + }, + "level": { + "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", + "enum": [ + "Group", + "Org" + ], + "type": "string" + }, + "name": { + "description": "A human-friendly name of the service account.", + "type": "string" + }, + "role_id": { + "description": "The ID of the role which the Service Account is associated with.", + "format": "uuid", + "type": "string" + } }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" + "required": [ + "name", + "auth_type", + "role_id" + ], + "type": "object" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "properties": { + "first": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "last": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "next": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "prev": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "related": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "self": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } + "type": "object" }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": { "type": "string" } }, "required": [ - "version" + "type", + "id", + "attributes" ], "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "errors" + "data", + "links" ], "type": "object" } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Service account is returned.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, - "409": { + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -20389,6 +22805,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -20463,7 +22931,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -20524,7 +22992,7 @@ } } }, - "500": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -20571,6 +23039,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -20645,7 +23165,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -20705,84 +23225,8 @@ } } } - } - }, - "summary": "Get a list of apps created by an organization.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2022-03-11" - ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" - }, - "post": { - "deprecated": true, - "description": "Create a new app for an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.", - "operationId": "createApp", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/AppPostRequest" - } - } - }, - "description": "app to be created" - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/AppPostResponse" - } - } - }, - "description": "Created Snyk App successfully", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } }, - "400": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -20829,6 +23273,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -20903,7 +23399,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -20964,7 +23460,7 @@ } } }, - "401": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -21011,6 +23507,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -21085,7 +23633,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -21146,7 +23694,7 @@ } } }, - "403": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -21193,6 +23741,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -21267,7 +23867,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -21327,221 +23927,514 @@ } } } + } + }, + "summary": "Update a group service account.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-version": "2023-09-07" + }, + "x-snyk-api-resource": "service_accounts" + }, + "/groups/{group_id}/service_accounts/{serviceaccount_id}/secrets": { + "post": { + "description": "Manage the client secret of a group service account by the service account ID.", + "operationId": "updateServiceAccountSecret", + "parameters": [ + { + "description": "The ID of the Snyk Group that owns the service account.", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, - "404": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", + "mode": { + "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated secret.\n * `create` - Add a new secret, preserving existing secrets. A maximum of to two secrets can exist at a time.\n * `delete` - Remove an existing secret by value. At least one secret must remain per service account.\n", + "enum": [ + "replace", + "create", + "delete" + ], "type": "string" }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", + "secret": { + "description": "Secret to delete when using `delete` mode", "type": "string" } }, "required": [ - "status", - "detail" + "mode" ], "type": "object" }, - "minItems": 1, - "type": "array" + "type": { + "description": "The Resource type.", + "enum": [ + "service_account" + ], + "type": "string" + } }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Not Found: The resource being operated on could not be found.", - "headers": { - "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } - }, - "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } - }, - "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } - }, - "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } - }, - "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } - }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" } } }, - "409": { + "required": true + }, + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "properties": { + "access_token_ttl_seconds": { + "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", + "type": "number" + }, + "api_key": { + "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", + "type": "string" + }, + "auth_type": { + "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", + "enum": [ + "api_key", + "oauth_client_secret", + "oauth_private_key_jwt" + ], + "type": "string" + }, + "client_id": { + "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_client_secret or oauth_private_key_jwt.", + "type": "string" + }, + "client_secret": { + "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", + "type": "string" + }, + "jwks_url": { + "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", + "type": "string" + }, + "level": { + "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", + "enum": [ + "Group", + "Org" + ], + "type": "string" + }, + "name": { + "description": "A human-friendly name of the service account.", + "type": "string" + }, + "role_id": { + "description": "The ID of the role which the Service Account is associated with.", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "name", + "auth_type", + "role_id" + ], + "type": "object" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "properties": { + "first": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "last": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "next": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "prev": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "related": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "self": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data" + ], + "type": "object" + } + } + }, + "description": "Service account client secret has been updated.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { "description": "An application-specific error code, expressed as a string value.", "example": "entity-not-found", "type": "string" @@ -21557,6 +24450,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -21631,7 +24576,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -21692,7 +24637,7 @@ } } }, - "500": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -21739,6 +24684,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -21813,7 +24810,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -21873,100 +24870,8 @@ } } } - } - }, - "summary": "Create a new app for an organization.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2022-03-11" - ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" - }, - "x-snyk-api-resource": "apps" - }, - "/orgs/{org_id}/apps/creations": { - "get": { - "description": "Get a list of apps created by an organization.", - "operationId": "getOrgApps", - "parameters": [ - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/AppData" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of apps created by the specified organization", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -22013,6 +24918,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -22087,7 +25044,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -22148,7 +25105,7 @@ } } }, - "401": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -22195,6 +25152,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -22269,7 +25278,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -22330,7 +25339,7 @@ } } }, - "403": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -22377,6 +25386,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -22451,7 +25512,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -22511,8 +25572,87 @@ } } } + } + }, + "summary": "Manage a group service account's client secret.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-version": "2023-09-07" + }, + "x-snyk-api-resource": "service_accounts" + }, + "/groups/{group_id}/settings/iac": { + "get": { + "description": "Get the Infrastructure as Code Settings for a group.", + "operationId": "getIacSettingsForGroup", + "parameters": [ + { + "$ref": "#/components/parameters/Version" }, - "404": { + { + "description": "The id of the group whose Infrastructure as Code settings are requested", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/GroupIacSettingsResponse" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "The Infrastructure as Code Settings of the group.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -22559,6 +25699,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -22633,7 +25825,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -22694,7 +25886,7 @@ } } }, - "409": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -22741,6 +25933,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -22815,7 +26059,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -22876,7 +26120,7 @@ } } }, - "500": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -22923,6 +26167,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -22997,7 +26293,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -23057,83 +26353,8 @@ } } } - } - }, - "summary": "Get a list of apps created by an organization.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "post": { - "description": "Create a new Snyk App for an organization.", - "operationId": "createOrgApp", - "parameters": [ - { - "$ref": "#/components/parameters/Version" }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/AppPostRequest" - } - } - }, - "description": "Snyk App details for app to be created." - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/AppPostResponse" - } - } - }, - "description": "Created Snyk App successfully.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -23180,6 +26401,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -23254,7 +26527,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -23315,7 +26588,7 @@ } } }, - "401": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -23362,6 +26635,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -23436,7 +26761,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -23496,8 +26821,98 @@ } } } + } + }, + "summary": "Get the Infrastructure as Code Settings for a group", + "tags": [ + "IacSettings" + ], + "x-snyk-api-releases": [ + "2021-12-09" + ], + "x-snyk-api-version": "2021-12-09" + }, + "patch": { + "description": "Update the Infrastructure as Code Settings for a group.", + "operationId": "updateIacSettingsForGroup", + "parameters": [ + { + "$ref": "#/components/parameters/Version" }, - "403": { + { + "description": "The id of the group whose Infrastructure as Code settings are getting updated", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "$ref": "#/components/schemas/GroupIacSettingsRequest" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/GroupIacSettingsResponse" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "The Infrastructure as Code Settings of the group were updated.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -23544,6 +26959,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -23618,7 +27085,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -23679,7 +27146,7 @@ } } }, - "404": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -23726,6 +27193,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -23800,7 +27319,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -23861,7 +27380,7 @@ } } }, - "409": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -23908,6 +27427,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -23982,7 +27553,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -24043,7 +27614,7 @@ } } }, - "500": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -24090,6 +27661,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -24164,7 +27787,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -24224,72 +27847,8 @@ } } } - } - }, - "summary": "Create a new Snyk App for an organization.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "apps" - }, - "/orgs/{org_id}/apps/creations/{app_id}": { - "delete": { - "description": "Delete an app by its App ID.", - "operationId": "deleteAppByID", - "parameters": [ - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/AppId" - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "204": { - "description": "The app has been deleted", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } }, - "400": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -24336,6 +27895,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -24410,7 +28021,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -24470,8 +28081,44 @@ } } } + } + }, + "summary": "Update the Infrastructure as Code Settings for a group", + "tags": [ + "IacSettings" + ], + "x-snyk-api-releases": [ + "2021-12-09" + ], + "x-snyk-api-version": "2021-12-09" + }, + "x-snyk-api-resource": "iac_settings" + }, + "/groups/{group_id}/settings/pull_request_template": { + "delete": { + "description": "Delete your groups pull request template. This means Snyk pull requests will start to use the default template for this group.", + "operationId": "deletePullRequestTemplate", + "parameters": [ + { + "description": "Snyk Group ID", + "example": "7626925e-4b0f-11ee-be56-0242ac120002", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, - "401": { + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -24518,6 +28165,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -24592,7 +28291,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -24653,7 +28352,7 @@ } } }, - "403": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -24700,6 +28399,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -24774,7 +28525,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -24835,7 +28586,7 @@ } } }, - "404": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -24882,6 +28633,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -24956,7 +28759,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -25017,7 +28820,7 @@ } } }, - "409": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -25064,6 +28867,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -25138,7 +28993,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -25246,6 +29101,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -25382,24 +29289,25 @@ } } }, - "summary": "Delete an app by its App ID.", + "summary": "Delete pull request template for group", "tags": [ - "Apps" + "Pull Request Templates" ], "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" + "2023-10-13~beta", + "2024-05-08" ], - "x-snyk-api-version": "2023-11-03" + "x-snyk-api-version": "2024-05-08" }, "get": { - "description": "Get a Snyk App by its App ID.", - "operationId": "getAppByID", + "description": "Get your groups pull request template", + "operationId": "getPullRequestTemplate", "parameters": [ { - "description": "Org ID", + "description": "Snyk Group ID", + "example": "7626925e-4b0f-11ee-be56-0242ac120002", "in": "path", - "name": "org_id", + "name": "group_id", "required": true, "schema": { "format": "uuid", @@ -25407,10 +29315,16 @@ } }, { - "$ref": "#/components/parameters/AppId" + "$ref": "#/components/parameters/Version" }, { - "$ref": "#/components/parameters/Version" + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" } ], "responses": { @@ -25418,27 +29332,47 @@ "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/AppData" + "additionalProperties": false, + "description": "Fetch a pull request template response", + "properties": { + "attributes": { + "$ref": "#/components/schemas/PullRequestTemplateAttributes" + }, + "id": { + "$ref": "#/components/schemas/PullRequsetTemplateId" + }, + "type": { + "$ref": "#/components/schemas/Types" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/SelfLink" + "$ref": "#/components/schemas/PaginatedLinks" } }, "type": "object" } } }, - "description": "The requested app", + "description": "Fetch Pull Request Template for group.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -25503,6 +29437,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -25685,6 +29671,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -25759,7 +29797,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -25867,6 +29905,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -26049,6 +30139,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -26184,7 +30326,7 @@ } } }, - "409": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -26231,6 +30373,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -26305,7 +30499,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -26365,8 +30559,132 @@ } } } + } + }, + "summary": "Get pull request template for group", + "tags": [ + "Pull Request Templates" + ], + "x-snyk-api-releases": [ + "2023-10-13~beta", + "2024-05-08" + ], + "x-snyk-api-version": "2024-05-08" + }, + "post": { + "description": "Configures a group level pull request template that will be used on any org or project within that group", + "operationId": "createOrUpdatePullRequestTemplate", + "parameters": [ + { + "description": "Snyk Group ID", + "example": "7626925e-4b0f-11ee-be56-0242ac120002", + "in": "path", + "name": "group_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, - "500": { + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/PullRequestTemplateAttributes" + }, + "type": { + "$ref": "#/components/schemas/Types" + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "additionalProperties": false, + "description": "Create or update Pull Request Template response", + "properties": { + "attributes": { + "$ref": "#/components/schemas/PullRequestTemplateAttributes" + }, + "id": { + "$ref": "#/components/schemas/PullRequsetTemplateId" + }, + "type": { + "$ref": "#/components/schemas/Types" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" + } + }, + "type": "object" + } + } + }, + "description": "Pull Request Template created for group.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -26413,6 +30731,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -26487,7 +30857,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -26547,92 +30917,8 @@ } } } - } - }, - "summary": "Get a Snyk App by its App ID.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "patch": { - "description": "Update app creation attributes with App ID.", - "operationId": "updateAppCreationByID", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/AppId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/AppPatchRequest" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppData" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "The update app.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } }, - "400": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -26679,6 +30965,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -26753,7 +31091,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -26814,7 +31152,7 @@ } } }, - "401": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -26861,6 +31199,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -26935,7 +31325,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -26996,7 +31386,7 @@ } } }, - "403": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -27043,6 +31433,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -27117,7 +31559,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -27178,7 +31620,7 @@ } } }, - "404": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -27225,6 +31667,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -27299,7 +31793,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -27359,8 +31853,236 @@ } } } + } + }, + "summary": "Create or update pull request template for group", + "tags": [ + "Pull Request Templates" + ], + "x-snyk-api-releases": [ + "2023-10-13~beta", + "2024-05-08" + ], + "x-snyk-api-version": "2024-05-08" + }, + "x-snyk-api-resource": "pull-request-templates" + }, + "/openapi": { + "get": { + "description": "List available versions of OpenAPI specification", + "operationId": "listAPIVersions", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "description": "List of available versions is returned", + "headers": { + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + } + } }, - "409": { + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "tags": [ + "OpenAPI" + ] + } + }, + "/openapi/{version}": { + "get": { + "description": "Get OpenAPI specification effective at version.", + "operationId": "getAPIVersion", + "parameters": [ + { + "description": "The requested version of the API", + "in": "path", + "name": "version", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + }, + "description": "OpenAPI specification matching requested version is returned", + "headers": { + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "tags": [ + "OpenAPI" + ] + } + }, + "/orgs": { + "get": { + "description": "Get a paginated list of organizations you have access to.", + "operationId": "listOrgs", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "description": "If set, only return organizations within the specified group", + "in": "query", + "name": "group_id", + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "If true, only return organizations that are not part of a group.", + "in": "query", + "name": "is_personal", + "schema": { + "type": "boolean" + } + }, + { + "description": "Only return orgs whose slug exactly matches this value.", + "in": "query", + "name": "slug", + "schema": { + "maxLength": 100, + "pattern": "^[\\w.-]+$", + "type": "string" + } + }, + { + "description": "Only return orgs whose name contains this value.", + "in": "query", + "name": "name", + "schema": { + "maxLength": 100, + "type": "string" + } + }, + { + "description": "Expand the specified related resources in the response to include their attributes.", + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "member_role" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/OrgWithRelationships" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "A list of organizations you have access to.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -27407,6 +32129,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -27481,7 +32255,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -27542,7 +32316,7 @@ } } }, - "500": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -27589,6 +32363,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -27663,7 +32489,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -27723,152 +32549,21 @@ } } } - } - }, - "summary": "Update app creation attributes such as name, redirect URIs, and access token time to live using the App ID.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "apps" - }, - "/orgs/{org_id}/apps/creations/{app_id}/secrets": { - "post": { - "description": "Manage client secret for the Snyk App.", - "operationId": "manageAppCreationSecret", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } }, - { - "$ref": "#/components/parameters/AppId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "mode": { - "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n", - "enum": [ - "replace", - "create", - "delete" - ], - "type": "string" - }, - "secret": { - "description": "Secret to delete when using `delete` mode", - "type": "string" - } - }, - "required": [ - "mode" - ], - "type": "object" - }, - "type": { - "enum": [ - "app" - ], - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { + "403": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppDataWithSecret" - }, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "Secret has been updated.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" + "version": "1.0" } }, "properties": { @@ -27902,6 +32597,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -27976,7 +32723,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -28037,7 +32784,7 @@ } } }, - "401": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -28084,6 +32831,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -28158,7 +32957,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -28219,7 +33018,7 @@ } } }, - "403": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -28266,6 +33065,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -28340,7 +33191,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -28400,8 +33251,85 @@ } } } + } + }, + "summary": "List accessible organizations", + "tags": [ + "Orgs" + ], + "x-snyk-api-releases": [ + "2022-04-06~experimental", + "2022-12-15~beta", + "2023-05-29", + "2024-02-28" + ], + "x-snyk-api-version": "2024-02-28" + }, + "x-snyk-api-resource": "orgs" + }, + "/orgs/{org_id}": { + "get": { + "description": "Get the full details of an organization.", + "operationId": "getOrg", + "parameters": [ + { + "$ref": "#/components/parameters/Version" }, - "404": { + { + "description": "Unique identifier for org", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "example": "b667f176-df52-4b0a-9954-117af6b05ab7", + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "$ref": "#/components/schemas/Org" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" + } + }, + "type": "object" + } + } + }, + "description": "Returns an instance of an organization", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -28448,6 +33376,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -28522,7 +33502,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -28583,7 +33563,7 @@ } } }, - "409": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -28630,6 +33610,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -28704,7 +33736,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -28765,7 +33797,7 @@ } } }, - "500": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -28812,6 +33844,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -28886,7 +33970,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -28946,116 +34030,8 @@ } } } - } - }, - "summary": "Manage client secret for the Snyk App.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "apps" - }, - "/orgs/{org_id}/apps/installs": { - "get": { - "description": "Get a list of apps installed for an organization.", - "operationId": "getAppInstallsForOrg", - "parameters": [ - { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "app" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/AppInstallData" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of apps installed for the specified organization.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } }, - "400": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -29102,6 +34078,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -29176,7 +34204,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -29237,7 +34265,7 @@ } } }, - "401": { + "409": { "content": { "application/vnd.api+json": { "schema": { @@ -29284,6 +34312,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -29358,7 +34438,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -29419,7 +34499,7 @@ } } }, - "403": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -29466,6 +34546,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -29540,7 +34672,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -29600,8 +34732,136 @@ } } } + } + }, + "summary": "Get organization", + "tags": [ + "Orgs" + ], + "x-snyk-api-releases": [ + "2022-04-06~experimental", + "2022-12-15~beta", + "2023-05-29" + ], + "x-snyk-api-version": "2023-05-29" + }, + "patch": { + "description": "Update the details of an organization", + "operationId": "updateOrg", + "parameters": [ + { + "$ref": "#/components/parameters/Version" }, - "404": { + { + "description": "Unique identifier for org", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "example": "b667f176-df52-4b0a-9954-117af6b05ab7", + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/OrgUpdateAttributes" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/Types" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "additionalProperties": false, + "description": "org resource object", + "properties": { + "attributes": { + "$ref": "#/components/schemas/OrgAttributes" + }, + "id": { + "example": "d5b640e5-d88c-4c17-9bf0-93597b7a1ce2", + "format": "uuid", + "type": "string" + }, + "relationships": { + "$ref": "#/components/schemas/OrgRelationships" + }, + "type": { + "$ref": "#/components/schemas/Types" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" + } + }, + "type": "object" + } + } + }, + "description": "Instance of org is updated", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "204": { + "$ref": "#/components/responses/204" + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -29648,6 +34908,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -29722,7 +35034,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -29783,7 +35095,7 @@ } } }, - "409": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -29830,6 +35142,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -29904,7 +35268,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -29965,7 +35329,7 @@ } } }, - "500": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -30012,6 +35376,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -30086,7 +35502,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -30146,157 +35562,8 @@ } } } - } - }, - "summary": "Get a list of apps installed for an organization.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "post": { - "description": "Install a Snyk Apps to this organization, the Snyk App must use unattended authentication eg client credentials.", - "operationId": "createOrgAppInstall", - "parameters": [ - { - "$ref": "#/components/parameters/Version" }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "properties": { - "type": { - "enum": [ - "app_install" - ], - "example": "app_install", - "type": "string" - } - }, - "type": "object" - }, - "relationships": { - "additionalProperties": false, - "properties": { - "app": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "id": { - "$ref": "#/components/schemas/Uuid" - }, - "type": { - "enum": [ - "app" - ], - "example": "app", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "required": [ - "app" - ], - "type": "object" - } - }, - "required": [ - "data", - "relationships" - ], - "type": "object" - } - } - }, - "description": "App Install to be created" - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppInstallWithClient" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "The newly created app install.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -30343,6 +35610,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -30417,7 +35736,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -30478,7 +35797,7 @@ } } }, - "401": { + "409": { "content": { "application/vnd.api+json": { "schema": { @@ -30525,6 +35844,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -30599,7 +35970,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -30660,7 +36031,7 @@ } } }, - "403": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -30707,6 +36078,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -30781,7 +36204,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -30841,555 +36264,507 @@ } } } + } + }, + "summary": "Update organization", + "tags": [ + "Orgs" + ], + "x-snyk-api-releases": [ + "2022-04-06~experimental", + "2022-12-15~beta", + "2023-05-29" + ], + "x-snyk-api-version": "2023-05-29" + }, + "x-snyk-api-resource": "orgs" + }, + "/orgs/{org_id}/app_bots": { + "get": { + "deprecated": true, + "description": "Get a list of app bots authorized to an organization. Deprecated, use /orgs/{org_id}/apps/installs instead.", + "operationId": "getAppBots", + "parameters": [ + { + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "app" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" }, - "404": { + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/AppBot" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "A list of app bots authorized to the specified organization", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get a list of app bots authorized to an organization.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17" + }, + "x-snyk-api-resource": "app_bots" + }, + "/orgs/{org_id}/app_bots/{bot_id}": { + "delete": { + "deprecated": true, + "description": "Revoke app bot authorization. Deprecated, use /orgs/{org_id}/apps/installs/{install_id} instead.", + "operationId": "deleteAppBot", + "parameters": [ + { + "description": "The ID of the app bot", + "in": "path", + "name": "bot_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + } + ], + "responses": { + "204": { + "description": "The app bot has been deauthorized", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date-time", "type": "string" } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Revoke app bot authorization", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17" + }, + "x-snyk-api-resource": "app_bots" + }, + "/orgs/{org_id}/apps": { + "get": { + "deprecated": true, + "description": "Get a list of apps created by an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.", + "operationId": "getApps", + "parameters": [ + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/AppData" + }, + "type": "array" + }, "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "A list of apps created by the specified organization", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get a list of apps created by an organization.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17" + }, + "post": { + "deprecated": true, + "description": "Create a new app for an organization. Deprecated, use /orgs/{org_id}/apps/creations instead.", + "operationId": "createApp", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/AppPostRequest" + } + } + }, + "description": "app to be created" + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" + "$ref": "#/components/schemas/AppPostResponse" } + } + }, + "description": "Created Snyk App successfully", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" }, - "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", + "location": { "schema": { - "format": "date-time", "type": "string" } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Create a new app for an organization.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17" + }, + "x-snyk-api-resource": "apps" + }, + "/orgs/{org_id}/apps/creations": { + "get": { + "description": "Get a list of apps created by an organization.", + "operationId": "getOrgApps", + "parameters": [ + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/AppData" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "A list of apps created by the specified organization", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" } }, - "summary": "Install a Snyk Apps to this organization.", + "summary": "Get a list of apps created by an organization.", "tags": [ "Apps" ], @@ -31399,33 +36774,37 @@ ], "x-snyk-api-version": "2023-11-03" }, - "x-snyk-api-resource": "app_installs" - }, - "/orgs/{org_id}/apps/installs/{install_id}": { - "delete": { - "description": "Revoke app authorization for an Snyk Organization with install ID.", - "operationId": "deleteAppOrgInstallByID", + "post": { + "description": "Create a new Snyk App for an organization.", + "operationId": "createOrgApp", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/InstallId" + "$ref": "#/components/parameters/OrgId" } ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/AppPostRequest" + } + } + }, + "description": "Snyk App details for app to be created." + }, "responses": { - "204": { - "description": "The app install has been revoked.", + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/AppPostResponse" + } + } + }, + "description": "Created Snyk App successfully.", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" @@ -31453,1096 +36832,776 @@ } }, "400": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Create a new Snyk App for an organization.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03" + ], + "x-snyk-api-version": "2023-11-03" + }, + "x-snyk-api-resource": "apps" + }, + "/orgs/{org_id}/apps/creations/{app_id}": { + "delete": { + "description": "Delete an app by its App ID.", + "operationId": "deleteAppByID", + "parameters": [ + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/AppId" + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "204": { + "description": "The app has been deleted", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date-time", "type": "string" } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Delete an app by its App ID.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03" + ], + "x-snyk-api-version": "2023-11-03" + }, + "get": { + "description": "Get a Snyk App by its App ID.", + "operationId": "getAppByID", + "parameters": [ + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/AppId" + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/AppData" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "The requested app", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get a Snyk App by its App ID.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03" + ], + "x-snyk-api-version": "2023-11-03" + }, + "patch": { + "description": "Update app creation attributes with App ID.", + "operationId": "updateAppCreationByID", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/AppId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/AppPatchRequest" + } + } + } + }, + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppData" + }, "jsonapi": { - "version": "1.0" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" } }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", + "type": "object" + } + } + }, + "description": "The update app.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Update app creation attributes such as name, redirect URIs, and access token time to live using the App ID.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03" + ], + "x-snyk-api-version": "2023-11-03" + }, + "x-snyk-api-resource": "apps" + }, + "/orgs/{org_id}/apps/creations/{app_id}/secrets": { + "post": { + "description": "Manage client secret for the Snyk App.", + "operationId": "manageAppCreationSecret", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/AppId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "additionalProperties": false, + "properties": { + "mode": { + "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n", + "enum": [ + "replace", + "create", + "delete" + ], "type": "string" }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", + "secret": { + "description": "Secret to delete when using `delete` mode", "type": "string" } }, "required": [ - "status", - "detail" + "mode" ], "type": "object" }, - "minItems": 1, - "type": "array" + "type": { + "enum": [ + "app" + ], + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/AppDataWithSecret" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Secret has been updated.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Manage client secret for the Snyk App.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03" + ], + "x-snyk-api-version": "2023-11-03" + }, + "x-snyk-api-resource": "apps" + }, + "/orgs/{org_id}/apps/installs": { + "get": { + "description": "Get a list of apps installed for an organization.", + "operationId": "getAppInstallsForOrg", + "parameters": [ + { + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "app" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/AppInstallData" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "A list of apps installed for the specified organization.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, "409": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get a list of apps installed for an organization.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-version": "2024-05-23" + }, + "post": { + "description": "Install a Snyk Apps to this organization, the Snyk App must use unattended authentication eg client credentials.", + "operationId": "createOrgAppInstall", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "properties": { + "type": { + "enum": [ + "app_install" + ], + "example": "app_install", + "type": "string" } - ], - "jsonapi": { - "version": "1.0" - } + }, + "type": "object" }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { + "relationships": { + "additionalProperties": false, + "properties": { + "app": { "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { + "data": { "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" + "id": { + "$ref": "#/components/schemas/Uuid" }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", + "type": { + "enum": [ + "app" + ], + "example": "app", "type": "string" } }, + "required": [ + "id", + "type" + ], "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" } }, "required": [ - "status", - "detail" + "data" ], "type": "object" - }, - "minItems": 1, - "type": "array" + } + }, + "required": [ + "app" + ], + "type": "object" + } + }, + "required": [ + "data", + "relationships" + ], + "type": "object" + } + } + }, + "description": "App Install to be created" + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/AppInstallWithClient" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "The newly created app install.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date-time", "type": "string" } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "$ref": "#/components/responses/500" + } + }, + "summary": "Install a Snyk Apps to this organization.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-version": "2024-05-23" + }, + "x-snyk-api-resource": "app_installs" + }, + "/orgs/{org_id}/apps/installs/{install_id}": { + "delete": { + "description": "Revoke app authorization for an Snyk Organization with install ID.", + "operationId": "deleteAppOrgInstallById", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/InstallId" + } + ], + "responses": { + "204": { + "description": "The app install has been revoked.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date-time", "type": "string" } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" } }, "summary": "Revoke app authorization for an Snyk Organization with install ID.", @@ -32551,9 +37610,10 @@ ], "x-snyk-api-releases": [ "2023-06-19~experimental", - "2023-11-03" + "2023-11-03", + "2024-05-23" ], - "x-snyk-api-version": "2023-11-03" + "x-snyk-api-version": "2024-05-23" }, "x-snyk-api-resource": "app_installs" }, @@ -32566,14 +37626,7 @@ "$ref": "#/components/parameters/Version" }, { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/OrgId" }, { "$ref": "#/components/parameters/InstallId" @@ -32681,382 +37734,526 @@ } }, "400": { - "content": { - "application/vnd.api+json": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Manage client secret for non-interactive Snyk App installations.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-version": "2024-05-23" + }, + "x-snyk-api-resource": "app_installs" + }, + "/orgs/{org_id}/apps/{client_id}": { + "delete": { + "deprecated": true, + "description": "Delete an app by app id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.", + "operationId": "deleteApp", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/ClientId" + } + ], + "responses": { + "204": { + "description": "The app has been deleted", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "type": "string" + } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Delete an app", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17" + }, + "get": { + "deprecated": true, + "description": "Get an App by client id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.", + "operationId": "getApp", + "parameters": [ + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/ClientId" + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/AppData" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "The requested app", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get an app by client id", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17" + }, + "patch": { + "deprecated": true, + "description": "Update app attributes. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.", + "operationId": "updateApp", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/ClientId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/AppPatchRequest" + } + } + } + }, + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" + "data": { + "$ref": "#/components/schemas/AppData" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" } }, - "required": [ - "jsonapi", - "errors" - ], "type": "object" } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "The update app.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Update app attributes that are name, redirect URIs, and access token time to live", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17" + }, + "x-snyk-api-resource": "apps" + }, + "/orgs/{org_id}/apps/{client_id}/secrets": { + "post": { + "deprecated": true, + "description": "Manage client secrets for an app. Deprecated, use /orgs/{org_id}/apps/creations/{app_id}/secrets instead.", + "operationId": "manageSecrets", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/ClientId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "mode": { + "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n", + "enum": [ + "replace", + "create", + "delete" + ], + "type": "string" + }, + "secret": { + "description": "Secret to delete when using `delete` mode", + "type": "string" + } + }, + "required": [ + "mode" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { + "properties": { + "data": { + "$ref": "#/components/schemas/AppDataWithSecret" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" + } + }, + "type": "object" + } + } + }, + "description": "Secrets have been updated.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Manage client secrets for an app.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-version": "2022-03-11", + "x-snyk-sunset-eligible": "2024-07-17" + }, + "x-snyk-api-resource": "apps" + }, + "/orgs/{org_id}/audit_logs/search": { + "get": { + "description": "Search audit logs for an Organization. \"api.access\" events are omitted from results unless explicitly requested using the events parameter. Supported event types:\n - api.access\n - org.app_bot.create\n - org.app.create\n - org.app.delete\n - org.app.edit\n - org.cloud_config.settings.edit\n - org.collection.create\n - org.collection.delete\n - org.collection.edit\n - org.create\n - org.delete\n - org.edit\n - org.ignore_policy.edit\n - org.integration.create\n - org.integration.delete\n - org.integration.edit\n - org.integration.settings.edit\n - org.language_settings.edit\n - org.notification_settings.edit\n - org.org_source.create\n - org.org_source.delete\n - org.org_source.edit\n - org.policy.edit\n - org.project_filter.create\n - org.project_filter.delete\n - org.project.add\n - org.project.attributes.edit\n - org.project.delete\n - org.project.edit\n - org.project.fix_pr.auto_open\n - org.project.fix_pr.manual_open\n - org.project.ignore.create\n - org.project.ignore.delete\n - org.project.ignore.edit\n - org.project.monitor\n - org.project.pr_check.edit\n - org.project.remove\n - org.project.settings.delete\n - org.project.settings.edit\n - org.project.stop_monitor\n - org.project.tag.add\n - org.project.tag.remove\n - org.project.test\n - org.request_access_settings.edit\n - org.sast_settings.edit\n - org.service_account.create\n - org.service_account.delete\n - org.service_account.edit\n - org.settings.feature_flag.edit\n - org.target.create\n - org.target.delete\n - org.user.add\n - org.user.invite\n - org.user.invite.accept\n - org.user.invite.revoke\n - org.user.invite_link.accept\n - org.user.invite_link.create\n - org.user.invite_link.revoke\n - org.user.leave\n - org.user.provision.accept\n - org.user.provision.create\n - org.user.provision.delete\n - org.user.remove\n - org.user.role.create\n - org.user.role.delete\n - org.user.role.details.edit\n - org.user.role.edit\n - org.user.role.permissions.edit\n - org.webhook.add\n - org.webhook.delete\n - user.org.notification_settings.edit\n", + "operationId": "listOrgAuditLogs", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The ID of the organization.", + "example": "0d3728ec-eebf-484d-9907-ba238019f10b", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Cursor" + }, + { + "$ref": "#/components/parameters/From" + }, + { + "$ref": "#/components/parameters/To" + }, + { + "$ref": "#/components/parameters/Size" + }, + { + "$ref": "#/components/parameters/SortOrder" + }, + { + "$ref": "#/components/parameters/UserId" + }, + { + "$ref": "#/components/parameters/ProjectId" + }, + { + "$ref": "#/components/parameters/Events" + }, + { + "$ref": "#/components/parameters/ExcludeEvents" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/AuditLogSearch" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data" + ], + "type": "object" + } + } + }, + "description": "Organization Audit Logs.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "schema": { + "type": "string" + } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { "version": "1.0" } }, @@ -33091,6 +38288,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -33165,7 +38414,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -33226,7 +38475,7 @@ } } }, - "404": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -33273,6 +38522,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -33347,7 +38648,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -33408,7 +38709,7 @@ } } }, - "409": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -33455,6 +38756,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -33529,7 +38882,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -33590,7 +38943,7 @@ } } }, - "500": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -33637,6 +38990,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -33711,7 +39116,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -33771,73 +39176,8 @@ } } } - } - }, - "summary": "Manage client secret for non-interactive Snyk App installations.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "app_installs" - }, - "/orgs/{org_id}/apps/{client_id}": { - "delete": { - "deprecated": true, - "description": "Delete an app by app id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.", - "operationId": "deleteApp", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ClientId" - } - ], - "responses": { - "204": { - "description": "The app has been deleted", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } }, - "400": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -33884,6 +39224,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -33958,7 +39350,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -34018,13 +39410,138 @@ } } } - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { + } + }, + "summary": "Search Organization audit logs.", + "tags": [ + "Audit Logs" + ], + "x-snyk-api-releases": [ + "2023-09-11", + "2024-04-29" + ], + "x-snyk-api-version": "2024-04-29" + }, + "x-snyk-api-resource": "audit-logs", + "x-snyk-resource-singleton": true + }, + "/orgs/{org_id}/collections": { + "get": { + "description": "Return a list of organization's collections with issues counts and projects count.", + "operationId": "getCollections", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "description": "Return collections sorted by the specified attributes", + "in": "query", + "name": "sort", + "schema": { + "enum": [ + "name", + "projectsCount", + "issues" + ], + "type": "string" + } + }, + { + "description": "Return collections sorted in the specified direction", + "in": "query", + "name": "direction", + "schema": { + "default": "DESC", + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + } + }, + { + "allowEmptyValue": true, + "description": "Return collections which names include the provided string", + "in": "query", + "name": "name", + "schema": { + "maxLength": 255, + "type": "string" + } + }, + { + "allowEmptyValue": true, + "description": "Return collections where is_generated matches the provided boolean", + "in": "query", + "name": "is_generated", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/CollectionResponse" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" + } + }, + "type": "object" + } + } + }, + "description": "Returns a list of collections", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { "errors": [ { "detail": "Permission denied for this resource", @@ -34066,6 +39583,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -34140,7 +39709,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -34201,7 +39770,7 @@ } } }, - "403": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -34248,6 +39817,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -34322,7 +39943,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -34383,7 +40004,7 @@ } } }, - "404": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -34430,6 +40051,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -34504,7 +40177,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -34565,7 +40238,7 @@ } } }, - "409": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -34612,6 +40285,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -34686,7 +40411,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -34794,6 +40519,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -34930,47 +40707,66 @@ } } }, - "summary": "Delete an app", + "summary": "Get collections", "tags": [ - "Apps" + "Collection" ], "x-snyk-api-releases": [ - "2022-03-11" + "2023-06-01~beta", + "2023-09-12" ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" + "x-snyk-api-version": "2023-09-12" }, - "get": { - "deprecated": true, - "description": "Get an App by client id. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.", - "operationId": "getApp", + "post": { + "description": "Create a collection", + "operationId": "createCollection", "parameters": [ { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ClientId" + "$ref": "#/components/parameters/Version" }, { - "$ref": "#/components/parameters/Version" + "$ref": "#/components/parameters/OrgId" } ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/CreateCollectionRequest" + } + } + } + }, "responses": { - "200": { + "201": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/AppData" + "additionalProperties": false, + "description": "collection resource object", + "properties": { + "attributes": { + "$ref": "#/components/schemas/CollectionAttributes" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "relationships": { + "$ref": "#/components/schemas/CollectionRelationships" + }, + "type": { + "$ref": "#/components/schemas/Types" + } + }, + "required": [ + "id", + "attributes", + "relationships" + ], + "type": "object" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" @@ -34983,11 +40779,14 @@ } } }, - "description": "The requested app", + "description": "Returned collection", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -35052,6 +40851,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -35234,6 +41085,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -35308,7 +41211,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -35416,6 +41319,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -35598,6 +41553,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -35780,6 +41787,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -35962,6 +42021,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -36098,73 +42209,43 @@ } } }, - "summary": "Get an app by client id", + "summary": "Create a collection", "tags": [ - "Apps" + "Collection" ], "x-snyk-api-releases": [ - "2022-03-11" + "2023-06-01~beta", + "2023-09-12" ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" + "x-snyk-api-version": "2023-09-12" }, - "patch": { - "deprecated": true, - "description": "Update app attributes. Deprecated, use /orgs/{org_id}/apps/creations/{app_id} instead.", - "operationId": "updateApp", + "x-snyk-api-resource": "collections" + }, + "/orgs/{org_id}/collections/{collection_id}": { + "delete": { + "description": "Delete a collection", + "operationId": "deleteCollection", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/OrgId" }, { - "$ref": "#/components/parameters/ClientId" + "$ref": "#/components/parameters/CollectionId" } ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/AppPatchRequest" - } - } - } - }, "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AppData" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" - } - }, - "type": "object" - } - } - }, - "description": "The update app.", + "204": { + "description": "Collection was deleted successfully", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -36229,6 +42310,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -36411,6 +42544,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -36485,7 +42670,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -36593,6 +42778,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -36775,6 +43012,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -36957,6 +43246,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -37139,6 +43480,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -37275,78 +43668,60 @@ } } }, - "summary": "Update app attributes that are name, redirect URIs, and access token time to live", + "summary": "Delete a collection", "tags": [ - "Apps" + "Collection" ], "x-snyk-api-releases": [ - "2022-03-11" + "2023-06-01~beta", + "2023-09-12" ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" + "x-snyk-api-version": "2023-09-12" }, - "x-snyk-api-resource": "apps" - }, - "/orgs/{org_id}/apps/{client_id}/secrets": { - "post": { - "deprecated": true, - "description": "Manage client secrets for an app. Deprecated, use /orgs/{org_id}/apps/creations/{app_id}/secrets instead.", - "operationId": "manageSecrets", + "get": { + "description": "Get a collection", + "operationId": "getCollection", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/OrgId" }, { - "$ref": "#/components/parameters/ClientId" + "$ref": "#/components/parameters/CollectionId" } ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "mode": { - "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated\nsecret\n * `create` - Add a new secret, preserving existing secrets\n * `delete` - Remove an existing secret by value\n", - "enum": [ - "replace", - "create", - "delete" - ], - "type": "string" - }, - "secret": { - "description": "Secret to delete when using `delete` mode", - "type": "string" - } - }, - "required": [ - "mode" - ], - "type": "object" - } - } - } - }, "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { - "additionalProperties": false, "properties": { "data": { - "$ref": "#/components/schemas/AppDataWithSecret" + "additionalProperties": false, + "description": "collection resource object", + "properties": { + "attributes": { + "$ref": "#/components/schemas/CollectionAttributes" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "relationships": { + "$ref": "#/components/schemas/CollectionRelationships" + }, + "type": { + "$ref": "#/components/schemas/Types" + } + }, + "required": [ + "id", + "attributes", + "relationships" + ], + "type": "object" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" @@ -37359,11 +43734,14 @@ } } }, - "description": "Secrets have been updated.", + "description": "Returned collection", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -37428,6 +43806,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -37610,6 +44040,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -37684,7 +44166,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -37792,6 +44274,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -37974,6 +44508,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -38156,6 +44742,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -38338,6 +44976,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -38474,273 +45164,7 @@ } } }, - "summary": "Manage client secrets for an app.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2022-03-11" - ], - "x-snyk-api-version": "2022-03-11", - "x-snyk-sunset-eligible": "2024-07-17" - }, - "x-snyk-api-resource": "apps" - }, - "/orgs/{org_id}/audit_logs/search": { - "get": { - "description": "Search audit logs for an Organization. \"api.access\" events are omitted from results unless explicitly requested using the events parameter. Supported event types:\n - api.access\n - org.app_bot.create\n - org.app.create\n - org.app.delete\n - org.app.edit\n - org.cloud_config.settings.edit\n - org.collection.create\n - org.collection.delete\n - org.collection.edit\n - org.create\n - org.delete\n - org.edit\n - org.ignore_policy.edit\n - org.integration.create\n - org.integration.delete\n - org.integration.edit\n - org.integration.settings.edit\n - org.language_settings.edit\n - org.notification_settings.edit\n - org.org_source.create\n - org.org_source.delete\n - org.org_source.edit\n - org.policy.edit\n - org.project_filter.create\n - org.project_filter.delete\n - org.project.add\n - org.project.attributes.edit\n - org.project.delete\n - org.project.edit\n - org.project.fix_pr.auto_open\n - org.project.fix_pr.manual_open\n - org.project.ignore.create\n - org.project.ignore.delete\n - org.project.ignore.edit\n - org.project.monitor\n - org.project.pr_check.edit\n - org.project.remove\n - org.project.settings.delete\n - org.project.settings.edit\n - org.project.stop_monitor\n - org.project.tag.add\n - org.project.tag.remove\n - org.project.test\n - org.request_access_settings.edit\n - org.sast_settings.edit\n - org.service_account.create\n - org.service_account.delete\n - org.service_account.edit\n - org.settings.feature_flag.edit\n - org.target.create\n - org.target.delete\n - org.user.add\n - org.user.invite\n - org.user.invite.accept\n - org.user.invite.revoke\n - org.user.invite_link.accept\n - org.user.invite_link.create\n - org.user.invite_link.revoke\n - org.user.leave\n - org.user.provision.accept\n - org.user.provision.create\n - org.user.provision.delete\n - org.user.remove\n - org.user.role.create\n - org.user.role.delete\n - org.user.role.details.edit\n - org.user.role.edit\n - org.user.role.permissions.edit\n - org.webhook.add\n - org.webhook.delete\n - user.org.notification_settings.edit\n", - "operationId": "listOrgAuditLogs", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/OrgId" - }, - { - "$ref": "#/components/parameters/Cursor" - }, - { - "$ref": "#/components/parameters/From" - }, - { - "$ref": "#/components/parameters/To" - }, - { - "$ref": "#/components/parameters/Size" - }, - { - "$ref": "#/components/parameters/SortOrder" - }, - { - "$ref": "#/components/parameters/UserId" - }, - { - "$ref": "#/components/parameters/ProjectId" - }, - { - "$ref": "#/components/parameters/Events" - }, - { - "$ref": "#/components/parameters/ExcludeEvents" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/AuditLogSearch" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data" - ], - "type": "object" - } - } - }, - "description": "Organization Audit Logs.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Search Organization audit logs.", - "tags": [ - "Audit Logs" - ], - "x-snyk-api-releases": [ - "2023-09-11", - "2024-04-29" - ], - "x-snyk-api-version": "2024-04-29" - }, - "x-snyk-api-resource": "audit-logs", - "x-snyk-resource-singleton": true - }, - "/orgs/{org_id}/collections": { - "get": { - "description": "Return a list of organization's collections with issues counts and projects count.", - "operationId": "getCollections", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "description": "Return collections sorted by the specified attributes", - "in": "query", - "name": "sort", - "schema": { - "enum": [ - "name", - "projectsCount", - "issues" - ], - "type": "string" - } - }, - { - "description": "Return collections sorted in the specified direction", - "in": "query", - "name": "direction", - "schema": { - "default": "DESC", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - } - }, - { - "allowEmptyValue": true, - "description": "Return collections which names include the provided string", - "in": "query", - "name": "name", - "schema": { - "maxLength": 255, - "type": "string" - } - }, - { - "allowEmptyValue": true, - "description": "Return collections where is_generated matches the provided boolean", - "in": "query", - "name": "is_generated", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/CollectionResponse" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "type": "object" - } - } - }, - "description": "Returns a list of collections", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get collections", + "summary": "Get a collection", "tags": [ "Collection" ], @@ -38750,35 +45174,31 @@ ], "x-snyk-api-version": "2023-09-12" }, - "post": { - "description": "Create a collection", - "operationId": "createCollection", + "patch": { + "description": "Edit a collection", + "operationId": "updateCollection", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/CollectionId" } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/CreateCollectionRequest" + "$ref": "#/components/schemas/UpdateCollectionRequest" } } } }, "responses": { - "201": { + "200": { "content": { "application/vnd.api+json": { "schema": { @@ -38845,988 +45265,1456 @@ } }, "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Create a collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "x-snyk-api-resource": "collections" - }, - "/orgs/{org_id}/collections/{collection_id}": { - "delete": { - "description": "Delete a collection", - "operationId": "deleteCollection", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/CollectionId" - } - ], - "responses": { - "204": { - "description": "Collection was deleted successfully", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Delete a collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "get": { - "description": "Get a collection", - "operationId": "getCollection", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/CollectionId" - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { "additionalProperties": false, - "description": "collection resource object", + "example": { + "version": "1.0" + }, "properties": { - "attributes": { - "$ref": "#/components/schemas/CollectionAttributes" - }, - "id": { - "format": "uuid", + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string" - }, - "relationships": { - "$ref": "#/components/schemas/CollectionRelationships" - }, - "type": { - "$ref": "#/components/schemas/Types" } }, "required": [ - "id", - "attributes", - "relationships" + "version" ], "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" } }, + "required": [ + "jsonapi", + "errors" + ], "type": "object" } } }, - "description": "Returned collection", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get a collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "patch": { - "description": "Edit a collection", - "operationId": "updateCollection", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/CollectionId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/UpdateCollectionRequest" - } - } - } - }, - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { "additionalProperties": false, - "description": "collection resource object", + "example": { + "version": "1.0" + }, "properties": { - "attributes": { - "$ref": "#/components/schemas/CollectionAttributes" - }, - "id": { - "format": "uuid", + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string" - }, - "relationships": { - "$ref": "#/components/schemas/CollectionRelationships" - }, - "type": { - "$ref": "#/components/schemas/Types" } }, "required": [ - "id", - "attributes", - "relationships" + "version" ], "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" } }, + "required": [ + "jsonapi", + "errors" + ], "type": "object" } } }, - "description": "Returned collection", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Edit a collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "x-snyk-api-resource": "collections" - }, - "/orgs/{org_id}/collections/{collection_id}/relationships/projects": { - "delete": { - "description": "Remove projects from a collection by specifying an array of project ids", - "operationId": "deleteProjectsCollection", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/CollectionId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/DeleteProjectsFromCollectionRequest" - } - } - } - }, - "responses": { - "204": { - "description": "successfully removing projects from a collection", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Remove projects from a collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "get": { - "description": "Return a list of organization's projects that are from the specified collection.", - "operationId": "getProjectsOfCollection", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/CollectionId" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "description": "Return projects sorted by the specified attributes", - "in": "query", - "name": "sort", - "schema": { - "enum": [ - "imported", - "last_tested_at", - "issues" - ], - "type": "string" - } - }, - { - "description": "Return projects sorted in the specified direction", - "in": "query", - "name": "direction", - "schema": { - "default": "DESC", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - } - }, - { - "description": "Return projects that belong to the provided targets", - "in": "query", - "name": "target_id", - "schema": { - "items": { - "format": "uuid", - "type": "string" - }, - "maxItems": 25, - "type": "array" - } - }, - { - "description": "Return projects that are with or without issues", - "in": "query", - "name": "show", - "schema": { - "items": { - "enum": [ - "vuln-groups", - "clean-groups" - ], - "type": "string" - }, - "type": "array" - } - }, - { - "description": "Return projects that match the provided integration types", - "in": "query", - "name": "integration", - "schema": { - "items": { - "enum": [ - "acr", - "api", - "artifactory-cr", - "aws-lambda", - "azure-functions", - "azure-repos", - "bitbucket-cloud", - "bitbucket-connect-app", - "bitbucket-server", - "cli", - "cloud-foundry", - "digitalocean-cr", - "docker-hub", - "ecr", - "gcr", - "github-cr", - "github-enterprise", - "github", - "gitlab-cr", - "gitlab", - "google-artifact-cr", - "harbor-cr", - "heroku", - "ibm-cloud", - "kubernetes", - "nexus-cr", - "pivotal", - "quay-cr", - "terraform-cloud" - ], - "type": "string" - }, - "type": "array" - } - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/GetProjectsOfCollectionResponse" + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" } } }, - "description": "Returns a list of projects from the specified collection", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get projects from the specified collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "post": { - "description": "Add projects to a collection by specifying an array of project ids", - "operationId": "updateCollectionWithProjects", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/CollectionId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/UpdateCollectionWithProjectsRequest" + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } } - } - } - }, - "responses": { - "204": { - "description": "successfully adding projects to a collection", + }, + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Add projects to a collection", - "tags": [ - "Collection" - ], - "x-snyk-api-releases": [ - "2023-06-01~beta", - "2023-09-12" - ], - "x-snyk-api-version": "2023-09-12" - }, - "x-snyk-api-resource": "collections" - }, - "/orgs/{org_id}/container_images": { - "get": { - "description": "List instances of container image", - "operationId": "listContainerImage", - "parameters": [ - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "example": "f59045b3-f093-40c3-871d-a334ae30c568", - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ImageIds" - }, - { - "$ref": "#/components/parameters/Platform" - }, - { - "$ref": "#/components/parameters/Names" - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], "items": { - "$ref": "#/components/schemas/Image" + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" }, + "minItems": 1, "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, + "required": [ + "jsonapi", + "errors" + ], "type": "object" } } }, - "description": "Returns a list of container image instances", + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "List instances of container image", - "tags": [ - "ContainerImage" - ], - "x-snyk-api-releases": [ - "2023-03-08~beta", - "2023-08-18~beta", - "2023-11-02" - ], - "x-snyk-api-version": "2023-11-02" - }, - "x-snyk-api-resource": "container_images" - }, - "/orgs/{org_id}/container_images/{image_id}": { - "get": { - "description": "Get instance of container image", - "operationId": "getContainerImage", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "example": "f59045b3-f093-40c3-871d-a334ae30c568", - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ImageId" - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "$ref": "#/components/schemas/Image" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, + "required": [ + "jsonapi", + "errors" + ], "type": "object" } } }, - "description": "Returns an instance of container image", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" } }, - "summary": "Get instance of container image", + "summary": "Edit a collection", "tags": [ - "ContainerImage" + "Collection" ], "x-snyk-api-releases": [ - "2023-03-08~beta", - "2023-11-02" + "2023-06-01~beta", + "2023-09-12" ], - "x-snyk-api-version": "2023-11-02" + "x-snyk-api-version": "2023-09-12" }, - "x-snyk-api-resource": "container_images" + "x-snyk-api-resource": "collections" }, - "/orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs": { - "get": { - "description": "List instances of image target references for a container image", - "operationId": "listImageTargetRefs", + "/orgs/{org_id}/collections/{collection_id}/relationships/projects": { + "delete": { + "description": "Remove projects from a collection by specifying an array of project ids", + "operationId": "deleteProjectsCollection", "parameters": [ - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "example": "f59045b3-f093-40c3-871d-a334ae30c568", - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ImageId" - }, { "$ref": "#/components/parameters/Version" }, { - "$ref": "#/components/parameters/Limit" - }, - { - "$ref": "#/components/parameters/StartingAfter" + "$ref": "#/components/parameters/OrgId" }, { - "$ref": "#/components/parameters/EndingBefore" + "$ref": "#/components/parameters/CollectionId" } ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/ImageTargetRef" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "type": "object" - } + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/DeleteProjectsFromCollectionRequest" } - }, - "description": "Returns a list of image target references for a container image", + } + } + }, + "responses": { + "204": { + "description": "successfully removing projects from a collection", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -39845,393 +46733,19 @@ } }, "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "List instances of image target references for a container image", - "tags": [ - "ContainerImage" - ], - "x-snyk-api-releases": [ - "2023-08-18~beta", - "2023-11-02" - ], - "x-snyk-api-version": "2023-11-02" - }, - "x-snyk-api-resource": "container_images" - }, - "/orgs/{org_id}/invites": { - "get": { - "description": "List pending user invitations to an organization.", - "operationId": "listOrgInvitation", - "parameters": [ - { - "description": "The id of the org the user is being invited to", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/OrgInvitation" - }, - "type": "array" - }, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "List of pending invitations to an organization.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "List pending user invitations to an organization.", - "tags": [ - "Invites" - ], - "x-snyk-api-releases": [ - "2022-11-14" - ], - "x-snyk-api-version": "2022-11-14" - }, - "post": { - "description": "Invite a user to an organization with a role.", - "operationId": "createOrgInvitation", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the org the user is being invited to", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/OrgInvitationPostData" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/OrgInvitation" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data" - ], - "type": "object" - } - } - }, - "description": "A new organization invitation has been created", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Invite a user to an organization", - "tags": [ - "Invites" - ], - "x-snyk-api-releases": [ - "2022-06-01", - "2023-04-28" - ], - "x-snyk-api-version": "2023-04-28" - }, - "x-snyk-api-resource": "org_invitations" - }, - "/orgs/{org_id}/invites/{invite_id}": { - "delete": { - "description": "Cancel a pending user invitations to an organization.", - "operationId": "deleteOrgInvitation", - "parameters": [ - { - "description": "The id of the org the user is being invited to", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The id of the pending invite to cancel", - "in": "path", - "name": "invite_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Cancel a pending user invitations to an organization.", - "tags": [ - "Invites" - ], - "x-snyk-api-releases": [ - "2022-11-14" - ], - "x-snyk-api-version": "2022-11-14" - }, - "x-snyk-api-resource": "org_invitations" - }, - "/orgs/{org_id}/issues": { - "get": { - "description": "Get a list of an organization's issues.", - "operationId": "listOrgIssues", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "example": "4a18d42f-0706-4ad0-b127-24078731fbed", - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ScanItemId" - }, - { - "$ref": "#/components/parameters/ScanItemType" - }, - { - "$ref": "#/components/parameters/Type" - }, - { - "$ref": "#/components/parameters/UpdatedBefore" - }, - { - "$ref": "#/components/parameters/UpdatedAfter" - }, - { - "$ref": "#/components/parameters/CreatedBefore" - }, - { - "$ref": "#/components/parameters/CreatedAfter" - }, - { - "$ref": "#/components/parameters/EffectiveSeverityLevel" - }, - { - "$ref": "#/components/parameters/Status" - }, - { - "$ref": "#/components/parameters/Ignored" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/ListIssues200" - }, - "401": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" + "version": "1.0" } }, "properties": { @@ -40265,6 +46779,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -40339,7 +46905,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -40400,7 +46966,7 @@ } } }, - "403": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -40447,6 +47013,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -40521,7 +47139,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -40582,7 +47200,7 @@ } } }, - "404": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -40629,6 +47247,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -40703,7 +47373,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -40764,7 +47434,7 @@ } } }, - "500": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -40811,6 +47481,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -40885,7 +47607,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -40945,49 +47667,8 @@ } } } - } - }, - "summary": "Get issues by org ID", - "tags": [ - "Issues" - ], - "x-snyk-api-releases": [ - "2023-03-10~experimental", - "2023-09-29~beta", - "2024-01-23" - ], - "x-snyk-api-version": "2024-01-23" - }, - "x-snyk-api-resource": "issues" - }, - "/orgs/{org_id}/issues/{issue_id}": { - "get": { - "description": "Get an issue", - "operationId": "getOrgIssueByIssueID", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "example": "4a18d42f-0706-4ad0-b127-24078731fbed", - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/PathIssueId" - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/GetIssue200" }, - "400": { + "409": { "content": { "application/vnd.api+json": { "schema": { @@ -41034,6 +47715,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -41108,7 +47841,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -41169,7 +47902,7 @@ } } }, - "401": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -41216,6 +47949,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -41290,7 +48075,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -41350,8 +48135,169 @@ } } } + } + }, + "summary": "Remove projects from a collection", + "tags": [ + "Collection" + ], + "x-snyk-api-releases": [ + "2023-06-01~beta", + "2023-09-12" + ], + "x-snyk-api-version": "2023-09-12" + }, + "get": { + "description": "Return a list of organization's projects that are from the specified collection.", + "operationId": "getProjectsOfCollection", + "parameters": [ + { + "$ref": "#/components/parameters/Version" }, - "403": { + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/CollectionId" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "description": "Return projects sorted by the specified attributes", + "in": "query", + "name": "sort", + "schema": { + "enum": [ + "imported", + "last_tested_at", + "issues" + ], + "type": "string" + } + }, + { + "description": "Return projects sorted in the specified direction", + "in": "query", + "name": "direction", + "schema": { + "default": "DESC", + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + } + }, + { + "description": "Return projects that belong to the provided targets", + "in": "query", + "name": "target_id", + "schema": { + "items": { + "format": "uuid", + "type": "string" + }, + "maxItems": 25, + "type": "array" + } + }, + { + "description": "Return projects that are with or without issues", + "in": "query", + "name": "show", + "schema": { + "items": { + "enum": [ + "vuln-groups", + "clean-groups" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Return projects that match the provided integration types", + "in": "query", + "name": "integration", + "schema": { + "items": { + "enum": [ + "acr", + "api", + "artifactory-cr", + "aws-lambda", + "azure-functions", + "azure-repos", + "bitbucket-cloud", + "bitbucket-connect-app", + "bitbucket-server", + "cli", + "cloud-foundry", + "digitalocean-cr", + "docker-hub", + "ecr", + "gcr", + "github-cr", + "github-enterprise", + "github", + "gitlab-cr", + "gitlab", + "google-artifact-cr", + "harbor-cr", + "heroku", + "ibm-cloud", + "kubernetes", + "nexus-cr", + "pivotal", + "quay-cr", + "terraform-cloud" + ], + "type": "string" + }, + "type": "array" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/GetProjectsOfCollectionResponse" + } + } + }, + "description": "Returns a list of projects from the specified collection", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -41398,6 +48344,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -41472,7 +48470,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -41533,7 +48531,7 @@ } } }, - "404": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -41580,6 +48578,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -41654,7 +48704,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -41715,7 +48765,7 @@ } } }, - "409": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -41762,6 +48812,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -41836,7 +48938,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -41897,7 +48999,7 @@ } } }, - "500": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -41944,6 +49046,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -42018,7 +49172,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -42078,167 +49232,285 @@ } } } - } - }, - "summary": "Get an issue", - "tags": [ - "Issues" - ], - "x-snyk-api-releases": [ - "2024-01-23" - ], - "x-snyk-api-version": "2024-01-23" - }, - "x-snyk-api-resource": "issues" - }, - "/orgs/{org_id}/packages/issues": { - "post": { - "description": "This endpoint is not available to all customers. If you are interested please contact support. Query issues for a batch of packages identified by Package URL (purl). Only direct vulnerabilities are returned, transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.", - "operationId": "listIssuesForManyPurls", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Unique identifier for an organization", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/BulkPackageUrlsRequestBody" - } - } }, - "required": true - }, - "responses": { - "200": { + "500": { "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/IssuesWithPurlsResponse" + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" } } }, - "description": "Returns an array of issues with the purl identifier of the package that caused them", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/Location" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" } }, - "summary": "List issues for a given set of packages (Currently not available to all customers)", + "summary": "Get projects from the specified collection", "tags": [ - "Issues" + "Collection" ], "x-snyk-api-releases": [ - "2023-01-04~experimental", - "2023-03-29~beta", - "2023-04-17", - "2023-08-21" + "2023-06-01~beta", + "2023-09-12" ], - "x-snyk-api-version": "2023-08-21" + "x-snyk-api-version": "2023-09-12" }, - "x-snyk-api-resource": "issues" - }, - "/orgs/{org_id}/packages/{purl}/issues": { - "get": { - "description": "Query issues for a specific package version identified by Package URL (purl). Snyk returns only direct vulnerabilities. Transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.", - "operationId": "fetchIssuesPerPurl", + "post": { + "description": "Add projects to a collection by specifying an array of project ids", + "operationId": "updateCollectionWithProjects", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "$ref": "#/components/parameters/PackageUrl" - }, - { - "description": "Unique identifier for an organization", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Specify the number of results to skip before returning results. Must be greater than or equal to 0. Default is 0.", - "in": "query", - "name": "offset", - "schema": { - "type": "number" - } + "$ref": "#/components/parameters/OrgId" }, { - "description": "Specify the number of results to return. Must be greater than 0 and less than 1000. Default is 1000.", - "in": "query", - "name": "limit", - "schema": { - "type": "number" - } + "$ref": "#/components/parameters/CollectionId" } ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/IssuesResponse" - } + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/UpdateCollectionWithProjectsRequest" } - }, - "description": "Returns an array of issues", + } + } + }, + "responses": { + "204": { + "description": "successfully adding projects to a collection", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -42257,1105 +49529,528 @@ } }, "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "List issues for a package", - "tags": [ - "Issues" - ], - "x-snyk-api-releases": [ - "2022-06-29~beta", - "2022-09-15" - ], - "x-snyk-api-version": "2022-09-15" - }, - "x-snyk-api-resource": "issues" - }, - "/orgs/{org_id}/projects": { - "get": { - "description": "List all Projects for an Org.", - "operationId": "listOrgProjects", - "parameters": [ - { - "description": "The ID of the org that the projects belong to.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Return projects that belong to the provided targets", - "in": "query", - "name": "target_id", - "schema": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array" - } - }, - { - "description": "Return projects that match the provided target reference", - "in": "query", - "name": "target_reference", - "schema": { - "type": "string" - } - }, - { - "description": "Return projects that match the provided target file", - "in": "query", - "name": "target_file", - "schema": { - "type": "string" - } - }, - { - "description": "Return projects that match the provided target runtime", - "in": "query", - "name": "target_runtime", - "schema": { - "type": "string" - } - }, - { - "description": "The collection count.", - "in": "query", - "name": "meta_count", - "schema": { - "enum": [ - "only" - ], - "type": "string" - } - }, - { - "description": "Return projects that match the provided IDs.", - "explode": false, - "in": "query", - "name": "ids", - "schema": { - "items": { - "format": "uuid", - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match the provided names.", - "explode": false, - "in": "query", - "name": "names", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects with names starting with the specified prefix.", - "explode": false, - "in": "query", - "name": "names_start_with", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match the provided origins.", - "explode": false, - "in": "query", - "name": "origins", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match the provided types.", - "explode": false, - "in": "query", - "name": "types", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "target" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include a summary count for the issues found in the most recent scan of this project", - "in": "query", - "name": "meta.latest_issue_counts", - "schema": { - "type": "boolean" - } - }, - { - "description": "Include the total number of dependencies found in the most recent scan of this project", - "in": "query", - "name": "meta.latest_dependency_total", - "schema": { - "type": "boolean" - } - }, - { - "description": "Filter projects uploaded and monitored before this date (encoded value)", - "example": "2021-05-29T09:50:54.014Z", - "in": "query", - "name": "cli_monitored_before", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Filter projects uploaded and monitored after this date (encoded value)", - "example": "2021-05-29T09:50:54.014Z", - "in": "query", - "name": "cli_monitored_after", - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Return projects that match the provided importing user public ids.", - "explode": false, - "in": "query", - "name": "importing_user_public_id", - "schema": { - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match all the provided tags", - "example": [ - "key1:value1", - "key2:value2" - ], - "explode": false, - "in": "query", - "name": "tags", - "schema": { - "items": { - "pattern": "^[a-zA-Z0-9_-]+:[:/?#@&+=%a-zA-Z0-9_.~-]+$", - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match all the provided business_criticality value", - "explode": false, - "in": "query", - "name": "business_criticality", - "schema": { - "items": { - "enum": [ - "critical", - "high", - "medium", - "low" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match all the provided environment values", - "explode": false, - "in": "query", - "name": "environment", - "schema": { - "items": { - "enum": [ - "frontend", - "backend", - "internal", - "external", - "mobile", - "saas", - "onprem", - "hosted", - "distributed" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return projects that match all the provided lifecycle values", - "explode": false, - "in": "query", - "name": "lifecycle", - "schema": { - "items": { - "enum": [ - "production", - "development", - "sandbox" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], "items": { "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, "properties": { - "attributes": { - "$ref": "#/components/schemas/ProjectAttributes" + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" }, "id": { - "description": "Resource ID.", + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, "properties": { - "cli_monitored_at": { - "description": "The date that the project was last uploaded and monitored using cli.", - "example": "2021-05-29T09:50:54.014Z", - "format": "date-time", - "nullable": true, + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", "type": "string" }, - "latest_dependency_total": { - "$ref": "#/components/schemas/LatestDependencyTotal" - }, - "latest_issue_counts": { - "$ref": "#/components/schemas/LatestIssueCounts" + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" } }, "type": "object" }, - "relationships": { - "$ref": "#/components/schemas/ProjectRelationships" + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" }, - "type": { - "description": "The Resource type.", - "example": "project", + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", "type": "string" } }, "required": [ - "id", - "type", - "attributes" + "status", + "detail" ], "type": "object" }, + "minItems": 1, "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - }, - "meta": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, "properties": { - "count": { - "minimum": 0, - "type": "number" + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" } }, + "required": [ + "version" + ], "type": "object" } }, "required": [ "jsonapi", - "links" + "errors" ], "type": "object" } } }, - "description": "A list of projects is returned for the targeted org", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "List all Projects for an Org with the given Org ID.", - "tags": [ - "Projects" - ], - "x-snyk-api-releases": [ - "2021-06-04~beta", - "2022-08-12~experimental", - "2022-12-21~experimental", - "2023-02-15", - "2023-08-28", - "2023-09-11", - "2023-11-06" - ], - "x-snyk-api-version": "2023-11-06" - }, - "x-snyk-api-resource": "projects" - }, - "/orgs/{org_id}/projects/{project_id}": { - "delete": { - "description": "Delete one project in the organization by project ID.", - "operationId": "deleteOrgProject", - "parameters": [ - { - "description": "The ID of the org to which the project belongs to.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the project.", - "in": "path", - "name": "project_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "204": { - "description": "The project has been deleted", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Delete project by project ID.", - "tags": [ - "Projects" - ], - "x-snyk-api-releases": [ - "2023-11-06" - ], - "x-snyk-api-version": "2023-11-06" - }, - "get": { - "description": "Get one project of the organization by project ID.", - "operationId": "getOrgProject", - "parameters": [ - { - "description": "The ID of the org to which the project belongs to.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the project.", - "in": "path", - "name": "project_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "target" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include a summary count for the issues found in the most recent scan of this project", - "in": "query", - "name": "meta.latest_issue_counts", - "schema": { - "type": "boolean" - } - }, - { - "description": "Include the total number of dependencies found in the most recent scan of this project", - "in": "query", - "name": "meta.latest_dependency_total", - "schema": { - "type": "boolean" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "$ref": "#/components/schemas/ProjectAttributes" - }, - "id": { - "description": "The Resource ID.", - "format": "uuid", - "type": "string" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" }, - "meta": { - "additionalProperties": false, - "properties": { - "cli_monitored_at": { - "description": "The date that the project was last uploaded and monitored using cli.", - "example": "2021-05-29T09:50:54.014Z", - "format": "date-time", - "nullable": true, - "type": "string" + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" }, - "latest_dependency_total": { - "$ref": "#/components/schemas/LatestDependencyTotal" + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } }, - "latest_issue_counts": { - "$ref": "#/components/schemas/LatestIssueCounts" - } + "type": "object" }, - "type": "object" - }, - "relationships": { - "$ref": "#/components/schemas/ProjectRelationships" + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } }, - "type": { - "description": "The Resource type.", - "example": "project", + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string" } }, "required": [ - "id", - "type", - "attributes" + "version" ], "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "A project is returned for the targeted org", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get project by project ID.", - "tags": [ - "Projects" - ], - "x-snyk-api-releases": [ - "2022-02-01~experimental", - "2022-08-12~experimental", - "2022-12-21~experimental", - "2023-02-15", - "2023-08-28", - "2023-09-11", - "2023-11-06" - ], - "x-snyk-api-version": "2023-11-06" - }, - "patch": { - "description": "Updates one project of the organization by project ID.", - "operationId": "updateOrgProject", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The ID of the Org the project belongs to.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the project to patch.", - "in": "path", - "name": "project_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "target" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/PatchProjectRequest" - } - } - }, - "description": "The project attributes to be updated." - }, - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "$ref": "#/components/schemas/ProjectAttributes" - }, - "id": { - "description": "The Resource ID.", - "example": "331ede0a-de94-456f-b788-166caeca58bf", - "format": "uuid", - "type": "string" - }, - "links": { - "$ref": "#/components/schemas/Links" - }, - "meta": { - "additionalProperties": false, - "properties": { - "cli_monitored_at": { - "description": "The date that the project was last uploaded and monitored using cli.", - "example": "2021-05-29T09:50:54.014Z", - "format": "date-time", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "relationships": { - "$ref": "#/components/schemas/ProjectRelationships" - }, - "type": { - "description": "The Resource type.", - "example": "project", - "type": "string" - } - }, - "required": [ - "type", - "id", - "attributes" - ], - "type": "object" - }, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" + "version": "1.0" } }, - "required": [ - "jsonapi", - "data", - "links" - ], - "type": "object" - } - } - }, - "description": "A project is updated for the targeted org", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Updates project by project ID.", - "tags": [ - "Projects" - ], - "x-snyk-api-releases": [ - "2022-12-21~experimental", - "2023-02-15", - "2023-08-28", - "2023-09-11", - "2023-11-06" - ], - "x-snyk-api-version": "2023-11-06" - }, - "x-snyk-api-resource": "projects" - }, - "/orgs/{org_id}/projects/{project_id}/sbom": { - "get": { - "description": "This endpoint lets you retrieve the SBOM document of a software project.\nIt supports the following formats:\n* CycloneDX version 1.4 in JSON (set `format` to `cyclonedx1.4+json`).\n* CycloneDX version 1.4 in XML (set `format` to `cyclonedx1.4+xml`).\n* SPDX version 2.3 in JSON (set `format` to `spdx2.3+json`).\n\nBy default it will respond with an empty JSON:API response.", - "operationId": "getSbom", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Unique identifier for an organization", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Unique identifier for a project", - "in": "path", - "name": "project_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Format" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SpdxDocument" - } - }, - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/SbomResponse" - } - }, - "application/vnd.cyclonedx+json": { - "schema": { - "$ref": "#/components/schemas/CycloneDxDocument" - } - }, - "application/vnd.cyclonedx+xml": { - "schema": { - "$ref": "#/components/schemas/CycloneDxXmlDocument" - } - } - }, - "description": "Returns the SBOM document of a project", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get a project’s SBOM document", - "tags": [ - "SBOM" - ], - "x-snyk-api-releases": [ - "2022-03-31~experimental", - "2022-12-06~beta", - "2023-03-20", - "2024-03-12~experimental" - ], - "x-snyk-api-version": "2023-03-20" - }, - "x-snyk-api-resource": "sboms", - "x-snyk-resource-singleton": true - }, - "/orgs/{org_id}/service_accounts": { - "get": { - "description": "Get all service accounts for an organization.", - "operationId": "getManyOrgServiceAccounts", - "parameters": [ - { - "description": "The ID of the Snyk Organization that owns the service accounts.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, "properties": { - "data": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], "items": { "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, "properties": { - "attributes": { - "properties": { - "access_token_ttl_seconds": { - "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", - "type": "number" - }, - "api_key": { - "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", - "type": "string" - }, - "auth_type": { - "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", - "enum": [ - "api_key", - "oauth_client_secret", - "oauth_private_key_jwt" - ], - "type": "string" - }, - "client_id": { - "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "client_secret": { - "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", - "type": "string" - }, - "jwks_url": { - "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "level": { - "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", - "enum": [ - "Group", - "Org" - ], - "type": "string" - }, - "name": { - "description": "A human-friendly name of the service account.", - "type": "string" - }, - "role_id": { - "description": "The ID of the role which the Service Account is associated with.", - "format": "uuid", - "type": "string" - } - }, - "required": [ - "name", - "auth_type", - "role_id" - ], - "type": "object" + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" }, "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", "format": "uuid", "type": "string" }, "links": { "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, "properties": { - "first": { + "about": { "example": "https://example.com/api/resource", "oneOf": [ { @@ -43396,8 +50091,200 @@ "type": "object" } ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" }, - "last": { + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { "example": "https://example.com/api/resource", "oneOf": [ { @@ -43438,50 +50325,200 @@ "type": "object" } ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" }, - "next": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "prev": { + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "409": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { "example": "https://example.com/api/resource", "oneOf": [ { @@ -43522,8 +50559,200 @@ "type": "object" } ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" }, - "related": { + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { "example": "https://example.com/api/resource", "oneOf": [ { @@ -43564,2988 +50793,40331 @@ "type": "object" } ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" }, - "self": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" } }, "type": "object" }, - "type": { + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", "type": "string" } }, "required": [ - "type", - "id", - "attributes" + "status", + "detail" ], "type": "object" }, + "minItems": 1, "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "A list of service accounts is returned.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" } }, - "summary": "Get a list of organization service accounts.", + "summary": "Add projects to a collection", "tags": [ - "ServiceAccounts" + "Collection" ], "x-snyk-api-releases": [ - "2023-09-07" + "2023-06-01~beta", + "2023-09-12" ], - "x-snyk-api-version": "2023-09-07" + "x-snyk-api-version": "2023-09-12" }, - "post": { - "description": "Create a service account for an organization. The service account can be used to generate access tokens.", - "operationId": "createOrgServiceAccount", + "x-snyk-api-resource": "collections" + }, + "/orgs/{org_id}/container_images": { + "get": { + "description": "List instances of container image", + "operationId": "listContainerImage", "parameters": [ { - "description": "The ID of the Snyk Organization that is creating and will own the service account.", + "description": "Org ID", "in": "path", "name": "org_id", "required": true, "schema": { + "example": "f59045b3-f093-40c3-871d-a334ae30c568", "format": "uuid", "type": "string" } }, + { + "$ref": "#/components/parameters/ImageIds" + }, + { + "$ref": "#/components/parameters/Platform" + }, + { + "$ref": "#/components/parameters/Names" + }, { "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" } ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/Image" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" + } + }, + "type": "object" + } + } + }, + "description": "Returns a list of container image instances", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, "properties": { - "access_token_ttl_seconds": { - "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1 hour if unset. Only used when auth_type is one of the oauth_* variants.", - "maximum": 86400, - "minimum": 3600, - "type": "number" + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" }, - "auth_type": { - "description": "Authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out in OIDC Connect Core 1.0, section 9.", - "enum": [ - "api_key", - "oauth_client_secret", - "oauth_private_key_jwt" - ], + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", "type": "string" }, - "jwks_url": { - "description": "A JWKs URL hosting your public keys, used to verify signed JWT requests. Must be https. Required only when auth_type is oauth_private_key_jwt.", + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", "type": "string" }, - "name": { - "description": "A human-friendly name for the service account.", + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", "type": "string" }, - "role_id": { - "description": "The ID of the role which the created service account should use. Obtained in the Snyk UI, via \"Group Page\" -> \"Settings\" -> \"Member Roles\" -> \"Create new Role\". Can be shared among multiple accounts.", - "format": "uuid", + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", "type": "string" } }, "required": [ - "name", - "role_id", - "auth_type" + "status", + "detail" ], "type": "object" }, - "type": { - "description": "The Resource type.", - "enum": [ - "service_account" - ], - "type": "string" - } + "minItems": 1, + "type": "array" }, - "required": [ - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "required": true - }, - "responses": { - "201": { + "401": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "properties": { - "access_token_ttl_seconds": { - "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", - "type": "number" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" }, - "api_key": { - "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", - "type": "string" + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } }, - "auth_type": { - "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", - "enum": [ - "api_key", - "oauth_client_secret", - "oauth_private_key_jwt" - ], - "type": "string" - }, - "client_id": { - "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "client_secret": { - "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", - "type": "string" - }, - "jwks_url": { - "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "level": { - "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", - "enum": [ - "Group", - "Org" - ], - "type": "string" - }, - "name": { - "description": "A human-friendly name of the service account.", - "type": "string" - }, - "role_id": { - "description": "The ID of the role which the Service Account is associated with.", - "format": "uuid", - "type": "string" - } + "type": "object" }, - "required": [ - "name", - "auth_type", - "role_id" - ], - "type": "object" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "links": { - "additionalProperties": false, - "properties": { - "first": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "last": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "next": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "meta": { + "additionalProperties": true, + "example": { + "key": "value" }, - "prev": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" }, - "related": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } }, - "self": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - } + "type": "object" }, - "type": "object" + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } }, - "type": { + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string" } }, "required": [ - "type", - "id", - "attributes" + "version" ], "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "A new service account has been created", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Create a service account for an organization.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "x-snyk-api-resource": "service_accounts" - }, - "/orgs/{org_id}/service_accounts/{serviceaccount_id}": { - "delete": { - "description": "Delete a service account in an organization.", - "operationId": "deleteServiceAccount", - "parameters": [ - { - "description": "The ID of org to which the service account belongs.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the service account.", - "in": "path", - "name": "serviceaccount_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "204": { - "description": "The service account has been deleted.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Delete a service account in an organization.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "get": { - "description": "Get an organization-level service account by its ID.", - "operationId": "getOneOrgServiceAccount", - "parameters": [ - { - "description": "The ID of the Snyk Organization that owns the service account.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the service account.", - "in": "path", - "name": "serviceaccount_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "properties": { - "access_token_ttl_seconds": { - "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", - "type": "number" - }, - "api_key": { - "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", - "type": "string" - }, - "auth_type": { - "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", - "enum": [ - "api_key", - "oauth_client_secret", - "oauth_private_key_jwt" - ], - "type": "string" - }, - "client_id": { - "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "client_secret": { - "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", - "type": "string" - }, - "jwks_url": { - "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" - }, - "level": { - "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", - "enum": [ - "Group", - "Org" - ], - "type": "string" - }, - "name": { - "description": "A human-friendly name of the service account.", - "type": "string" - }, - "role_id": { - "description": "The ID of the role which the Service Account is associated with.", - "format": "uuid", - "type": "string" - } - }, - "required": [ - "name", - "auth_type", - "role_id" - ], - "type": "object" - }, - "id": { - "format": "uuid", - "type": "string" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" }, - "links": { - "additionalProperties": false, - "properties": { - "first": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" }, - "last": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "next": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "prev": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" + "type": "object" + } }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "required": [ + "href" + ], + "type": "object" + } + ] + } }, - "related": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" }, - "self": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - } + "type": "object" }, - "type": "object" + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } }, - "type": { + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string" } }, "required": [ - "type", - "id", - "attributes" + "version" ], "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "Service account is returned.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get an organization service account.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "patch": { - "description": "Update the name of an organization-level service account by its ID.", - "operationId": "updateOrgServiceAccount", - "parameters": [ - { - "description": "The ID of the Snyk Organization that owns the service account.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the service account.", - "in": "path", - "name": "serviceaccount_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, "properties": { - "name": { - "description": "A human-friendly name for the service account. Must be unique within the organization.", + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", "type": "string" } }, "required": [ - "name" + "status", + "detail" ], "type": "object" }, - "id": { - "description": "The ID of the service account. Must match the id in the url path.", - "format": "uuid", - "type": "string" - }, - "type": { - "description": "The Resource type.", - "enum": [ - "service_account" - ], - "type": "string" - } + "minItems": 1, + "type": "array" }, - "required": [ - "type", - "id", - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "required": true - }, - "responses": { - "200": { + "409": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "properties": { - "access_token_ttl_seconds": { - "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", - "type": "number" - }, - "api_key": { - "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", - "type": "string" - }, - "auth_type": { - "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", - "enum": [ - "api_key", - "oauth_client_secret", - "oauth_private_key_jwt" - ], - "type": "string" - }, - "client_id": { - "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" }, - "client_secret": { - "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", - "type": "string" + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } }, - "jwks_url": { - "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" }, - "level": { - "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", - "enum": [ - "Group", - "Org" - ], - "type": "string" + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" }, - "name": { - "description": "A human-friendly name of the service account.", - "type": "string" + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } }, - "role_id": { - "description": "The ID of the role which the Service Account is associated with.", - "format": "uuid", - "type": "string" - } + "type": "object" }, - "required": [ - "name", - "auth_type", - "role_id" - ], - "type": "object" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "links": { - "additionalProperties": false, - "properties": { - "first": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "last": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "next": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "prev": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "related": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "self": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - } + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" }, - "type": "object" + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } }, - "type": { + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string" } }, "required": [ - "type", - "id", - "attributes" + "version" ], "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "Service account is returned.", + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Update an organization service account.", - "tags": [ - "ServiceAccounts" - ], - "x-snyk-api-releases": [ - "2023-09-07" - ], - "x-snyk-api-version": "2023-09-07" - }, - "x-snyk-api-resource": "service_accounts" - }, - "/orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets": { - "post": { - "description": "Manage the client secret of an organization-level service account by the service account ID.", - "operationId": "updateOrgServiceAccountSecret", - "parameters": [ - { - "description": "The ID of the Snyk Organization that owns the service account.", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The ID of the service account.", - "in": "path", - "name": "serviceaccount_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/Version" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "mode": { - "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated secret.\n * `create` - Add a new secret, preserving existing secrets. A maximum of to two secrets can exist at a time.\n * `delete` - Remove an existing secret by value. At least one secret must remain per service account.\n", - "enum": [ - "replace", - "create", - "delete" - ], - "type": "string" - }, - "secret": { - "description": "Secret to delete when using `delete` mode", - "type": "string" - } - }, - "required": [ - "mode" - ], - "type": "object" - }, - "type": { - "description": "The Resource type.", - "enum": [ - "service_account" - ], - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - } - } - }, - "required": true - }, - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "properties": { - "access_token_ttl_seconds": { - "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", - "type": "number" - }, - "api_key": { - "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", - "type": "string" - }, - "auth_type": { - "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", - "enum": [ - "api_key", - "oauth_client_secret", - "oauth_private_key_jwt" - ], - "type": "string" - }, - "client_id": { - "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "List instances of container image", + "tags": [ + "ContainerImage" + ], + "x-snyk-api-releases": [ + "2023-03-08~beta", + "2023-08-18~beta", + "2023-11-02" + ], + "x-snyk-api-version": "2023-11-02" + }, + "x-snyk-api-resource": "container_images" + }, + "/orgs/{org_id}/container_images/{image_id}": { + "get": { + "description": "Get instance of container image", + "operationId": "getContainerImage", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "example": "f59045b3-f093-40c3-871d-a334ae30c568", + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/ImageId" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "$ref": "#/components/schemas/Image" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" + } + }, + "type": "object" + } + } + }, + "description": "Returns an instance of container image", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "409": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Get instance of container image", + "tags": [ + "ContainerImage" + ], + "x-snyk-api-releases": [ + "2023-03-08~beta", + "2023-11-02" + ], + "x-snyk-api-version": "2023-11-02" + }, + "x-snyk-api-resource": "container_images" + }, + "/orgs/{org_id}/container_images/{image_id}/relationships/image_target_refs": { + "get": { + "description": "List instances of image target references for a container image", + "operationId": "listImageTargetRefs", + "parameters": [ + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "example": "f59045b3-f093-40c3-871d-a334ae30c568", + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/ImageId" + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/ImageTargetRef" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" + } + }, + "type": "object" + } + } + }, + "description": "Returns a list of image target references for a container image", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "409": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "List instances of image target references for a container image", + "tags": [ + "ContainerImage" + ], + "x-snyk-api-releases": [ + "2023-08-18~beta", + "2023-11-02" + ], + "x-snyk-api-version": "2023-11-02" + }, + "x-snyk-api-resource": "container_images" + }, + "/orgs/{org_id}/invites": { + "get": { + "description": "List pending user invitations to an organization.", + "operationId": "listOrgInvitation", + "parameters": [ + { + "description": "The id of the org the user is being invited to", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/OrgInvitation" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "List of pending invitations to an organization.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "List pending user invitations to an organization.", + "tags": [ + "Invites" + ], + "x-snyk-api-releases": [ + "2022-11-14" + ], + "x-snyk-api-version": "2022-11-14" + }, + "post": { + "description": "Invite a user to an organization with a role.", + "operationId": "createOrgInvitation", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The id of the org the user is being invited to", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/OrgInvitationPostData" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/OrgInvitation" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data" + ], + "type": "object" + } + } + }, + "description": "A new organization invitation has been created", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "schema": { + "type": "string" + } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Invite a user to an organization", + "tags": [ + "Invites" + ], + "x-snyk-api-releases": [ + "2022-06-01", + "2023-04-28" + ], + "x-snyk-api-version": "2023-04-28" + }, + "x-snyk-api-resource": "org_invitations" + }, + "/orgs/{org_id}/invites/{invite_id}": { + "delete": { + "description": "Cancel a pending user invitations to an organization.", + "operationId": "deleteOrgInvitation", + "parameters": [ + { + "description": "The id of the org the user is being invited to", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The id of the pending invite to cancel", + "in": "path", + "name": "invite_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Cancel a pending user invitations to an organization.", + "tags": [ + "Invites" + ], + "x-snyk-api-releases": [ + "2022-11-14" + ], + "x-snyk-api-version": "2022-11-14" + }, + "x-snyk-api-resource": "org_invitations" + }, + "/orgs/{org_id}/issues": { + "get": { + "description": "Get a list of an organization's issues.", + "operationId": "listOrgIssues", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "example": "4a18d42f-0706-4ad0-b127-24078731fbed", + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/ScanItemId" + }, + { + "$ref": "#/components/parameters/ScanItemType" + }, + { + "$ref": "#/components/parameters/Type" + }, + { + "$ref": "#/components/parameters/UpdatedBefore" + }, + { + "$ref": "#/components/parameters/UpdatedAfter" + }, + { + "$ref": "#/components/parameters/CreatedBefore" + }, + { + "$ref": "#/components/parameters/CreatedAfter" + }, + { + "$ref": "#/components/parameters/EffectiveSeverityLevel" + }, + { + "$ref": "#/components/parameters/Status" + }, + { + "$ref": "#/components/parameters/Ignored" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/ListIssues200" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get issues by org ID", + "tags": [ + "Issues" + ], + "x-snyk-api-releases": [ + "2023-03-10~experimental", + "2023-09-29~beta", + "2024-01-23" + ], + "x-snyk-api-version": "2024-01-23" + }, + "x-snyk-api-resource": "issues" + }, + "/orgs/{org_id}/issues/{issue_id}": { + "get": { + "description": "Get an issue", + "operationId": "getOrgIssueByIssueID", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Org ID", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "example": "4a18d42f-0706-4ad0-b127-24078731fbed", + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/PathIssueId" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/GetIssue200" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get an issue", + "tags": [ + "Issues" + ], + "x-snyk-api-releases": [ + "2024-01-23" + ], + "x-snyk-api-version": "2024-01-23" + }, + "x-snyk-api-resource": "issues" + }, + "/orgs/{org_id}/packages/issues": { + "post": { + "description": "This endpoint is not available to all customers. If you are interested please contact support. Query issues for a batch of packages identified by Package URL (purl). Only direct vulnerabilities are returned, transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.", + "operationId": "listIssuesForManyPurls", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Unique identifier for an organization", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/BulkPackageUrlsRequestBody" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/IssuesWithPurlsResponse" + } + } + }, + "description": "Returns an array of issues with the purl identifier of the package that caused them", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/Location" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "409": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "List issues for a given set of packages (Currently not available to all customers)", + "tags": [ + "Issues" + ], + "x-snyk-api-releases": [ + "2023-01-04~experimental", + "2023-03-29~beta", + "2023-04-17", + "2023-08-21" + ], + "x-snyk-api-version": "2023-08-21" + }, + "x-snyk-api-resource": "issues" + }, + "/orgs/{org_id}/packages/{purl}/issues": { + "get": { + "description": "Query issues for a specific package version identified by Package URL (purl). Snyk returns only direct vulnerabilities. Transitive vulnerabilities (from dependencies) are not returned because they can vary depending on context.", + "operationId": "fetchIssuesPerPurl", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/PackageUrl" + }, + { + "description": "Unique identifier for an organization", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "Specify the number of results to skip before returning results. Must be greater than or equal to 0. Default is 0.", + "in": "query", + "name": "offset", + "schema": { + "type": "number" + } + }, + { + "description": "Specify the number of results to return. Must be greater than 0 and less than 1000. Default is 1000.", + "in": "query", + "name": "limit", + "schema": { + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/IssuesResponse" + } + } + }, + "description": "Returns an array of issues", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "409": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "List issues for a package", + "tags": [ + "Issues" + ], + "x-snyk-api-releases": [ + "2022-06-29~beta", + "2022-09-15" + ], + "x-snyk-api-version": "2022-09-15" + }, + "x-snyk-api-resource": "issues" + }, + "/orgs/{org_id}/projects": { + "get": { + "description": "List all Projects for an Org.", + "operationId": "listOrgProjects", + "parameters": [ + { + "description": "The ID of the org that the projects belong to.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "Return projects that belong to the provided targets", + "in": "query", + "name": "target_id", + "schema": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Return projects that match the provided target reference", + "in": "query", + "name": "target_reference", + "schema": { + "type": "string" + } + }, + { + "description": "Return projects that match the provided target file", + "in": "query", + "name": "target_file", + "schema": { + "type": "string" + } + }, + { + "description": "Return projects that match the provided target runtime", + "in": "query", + "name": "target_runtime", + "schema": { + "type": "string" + } + }, + { + "description": "The collection count.", + "in": "query", + "name": "meta_count", + "schema": { + "enum": [ + "only" + ], + "type": "string" + } + }, + { + "description": "Return projects that match the provided IDs.", + "explode": false, + "in": "query", + "name": "ids", + "schema": { + "items": { + "format": "uuid", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects that match the provided names.", + "explode": false, + "in": "query", + "name": "names", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects with names starting with the specified prefix.", + "explode": false, + "in": "query", + "name": "names_start_with", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects that match the provided origins.", + "explode": false, + "in": "query", + "name": "origins", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects that match the provided types.", + "explode": false, + "in": "query", + "name": "types", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "target" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include a summary count for the issues found in the most recent scan of this project", + "in": "query", + "name": "meta.latest_issue_counts", + "schema": { + "type": "boolean" + } + }, + { + "description": "Include the total number of dependencies found in the most recent scan of this project", + "in": "query", + "name": "meta.latest_dependency_total", + "schema": { + "type": "boolean" + } + }, + { + "description": "Filter projects uploaded and monitored before this date (encoded value)", + "example": "2021-05-29T09:50:54.014Z", + "in": "query", + "name": "cli_monitored_before", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Filter projects uploaded and monitored after this date (encoded value)", + "example": "2021-05-29T09:50:54.014Z", + "in": "query", + "name": "cli_monitored_after", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Return projects that match the provided importing user public ids.", + "explode": false, + "in": "query", + "name": "importing_user_public_id", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects that match all the provided tags", + "example": [ + "key1:value1", + "key2:value2" + ], + "explode": false, + "in": "query", + "name": "tags", + "schema": { + "items": { + "pattern": "^[a-zA-Z0-9_-]+:[:/?#@\u0026+=%a-zA-Z0-9_.~-]+$", + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects that match all the provided business_criticality value", + "explode": false, + "in": "query", + "name": "business_criticality", + "schema": { + "items": { + "enum": [ + "critical", + "high", + "medium", + "low" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects that match all the provided environment values", + "explode": false, + "in": "query", + "name": "environment", + "schema": { + "items": { + "enum": [ + "frontend", + "backend", + "internal", + "external", + "mobile", + "saas", + "onprem", + "hosted", + "distributed" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Return projects that match all the provided lifecycle values", + "explode": false, + "in": "query", + "name": "lifecycle", + "schema": { + "items": { + "enum": [ + "production", + "development", + "sandbox" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "items": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/ProjectAttributes" + }, + "id": { + "description": "Resource ID.", + "format": "uuid", + "type": "string" + }, + "meta": { + "additionalProperties": false, + "properties": { + "cli_monitored_at": { + "description": "The date that the project was last uploaded and monitored using cli.", + "example": "2021-05-29T09:50:54.014Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "latest_dependency_total": { + "$ref": "#/components/schemas/LatestDependencyTotal" + }, + "latest_issue_counts": { + "$ref": "#/components/schemas/LatestIssueCounts" + } + }, + "type": "object" + }, + "relationships": { + "$ref": "#/components/schemas/ProjectRelationships" + }, + "type": { + "description": "The Resource type.", + "example": "project", + "type": "string" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + }, + "meta": { + "properties": { + "count": { + "minimum": 0, + "type": "number" + } + }, + "type": "object" + } + }, + "required": [ + "jsonapi", + "links" + ], + "type": "object" + } + } + }, + "description": "A list of projects is returned for the targeted org", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "List all Projects for an Org with the given Org ID.", + "tags": [ + "Projects" + ], + "x-snyk-api-releases": [ + "2021-06-04~beta", + "2022-08-12~experimental", + "2022-12-21~experimental", + "2023-02-15", + "2023-08-28", + "2023-09-11", + "2023-11-06" + ], + "x-snyk-api-version": "2023-11-06" + }, + "x-snyk-api-resource": "projects" + }, + "/orgs/{org_id}/projects/{project_id}": { + "delete": { + "description": "Delete one project in the organization by project ID.", + "operationId": "deleteOrgProject", + "parameters": [ + { + "description": "The ID of the org to which the project belongs to.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the project.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "204": { + "description": "The project has been deleted", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Delete project by project ID.", + "tags": [ + "Projects" + ], + "x-snyk-api-releases": [ + "2023-11-06" + ], + "x-snyk-api-version": "2023-11-06" + }, + "get": { + "description": "Get one project of the organization by project ID.", + "operationId": "getOrgProject", + "parameters": [ + { + "description": "The ID of the org to which the project belongs to.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the project.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "target" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include a summary count for the issues found in the most recent scan of this project", + "in": "query", + "name": "meta.latest_issue_counts", + "schema": { + "type": "boolean" + } + }, + { + "description": "Include the total number of dependencies found in the most recent scan of this project", + "in": "query", + "name": "meta.latest_dependency_total", + "schema": { + "type": "boolean" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/ProjectAttributes" + }, + "id": { + "description": "The Resource ID.", + "format": "uuid", + "type": "string" + }, + "meta": { + "additionalProperties": false, + "properties": { + "cli_monitored_at": { + "description": "The date that the project was last uploaded and monitored using cli.", + "example": "2021-05-29T09:50:54.014Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "latest_dependency_total": { + "$ref": "#/components/schemas/LatestDependencyTotal" + }, + "latest_issue_counts": { + "$ref": "#/components/schemas/LatestIssueCounts" + } + }, + "type": "object" + }, + "relationships": { + "$ref": "#/components/schemas/ProjectRelationships" + }, + "type": { + "description": "The Resource type.", + "example": "project", + "type": "string" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "A project is returned for the targeted org", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Get project by project ID.", + "tags": [ + "Projects" + ], + "x-snyk-api-releases": [ + "2022-02-01~experimental", + "2022-08-12~experimental", + "2022-12-21~experimental", + "2023-02-15", + "2023-08-28", + "2023-09-11", + "2023-11-06" + ], + "x-snyk-api-version": "2023-11-06" + }, + "patch": { + "description": "Updates one project of the organization by project ID.", + "operationId": "updateOrgProject", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The ID of the Org the project belongs to.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the project to patch.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "target" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/PatchProjectRequest" + } + } + }, + "description": "The project attributes to be updated." + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "$ref": "#/components/schemas/ProjectAttributes" + }, + "id": { + "description": "The Resource ID.", + "example": "331ede0a-de94-456f-b788-166caeca58bf", + "format": "uuid", + "type": "string" + }, + "links": { + "$ref": "#/components/schemas/Links" + }, + "meta": { + "additionalProperties": false, + "properties": { + "cli_monitored_at": { + "description": "The date that the project was last uploaded and monitored using cli.", + "example": "2021-05-29T09:50:54.014Z", + "format": "date-time", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "$ref": "#/components/schemas/ProjectRelationships" + }, + "type": { + "description": "The Resource type.", + "example": "project", + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "A project is updated for the targeted org", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Updates project by project ID.", + "tags": [ + "Projects" + ], + "x-snyk-api-releases": [ + "2022-12-21~experimental", + "2023-02-15", + "2023-08-28", + "2023-09-11", + "2023-11-06" + ], + "x-snyk-api-version": "2023-11-06" + }, + "x-snyk-api-resource": "projects" + }, + "/orgs/{org_id}/projects/{project_id}/sbom": { + "get": { + "description": "This endpoint lets you retrieve the SBOM document of a software project.\nIt supports the following formats:\n* CycloneDX version 1.4 in JSON (set `format` to `cyclonedx1.4+json`).\n* CycloneDX version 1.4 in XML (set `format` to `cyclonedx1.4+xml`).\n* SPDX version 2.3 in JSON (set `format` to `spdx2.3+json`).\n\nBy default it will respond with an empty JSON:API response.", + "operationId": "getSbom", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "Unique identifier for an organization", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "Unique identifier for a project", + "in": "path", + "name": "project_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Format" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpdxDocument" + } + }, + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/SbomResponse" + } + }, + "application/vnd.cyclonedx+json": { + "schema": { + "$ref": "#/components/schemas/CycloneDxDocument" + } + }, + "application/vnd.cyclonedx+xml": { + "schema": { + "$ref": "#/components/schemas/CycloneDxXmlDocument" + } + } + }, + "description": "Returns the SBOM document of a project", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "409": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Get a project’s SBOM document", + "tags": [ + "SBOM" + ], + "x-snyk-api-releases": [ + "2022-03-31~experimental", + "2022-12-06~beta", + "2023-03-20", + "2024-03-12~experimental" + ], + "x-snyk-api-version": "2023-03-20" + }, + "x-snyk-api-resource": "sboms", + "x-snyk-resource-singleton": true + }, + "/orgs/{org_id}/service_accounts": { + "get": { + "description": "Get all service accounts for an organization.", + "operationId": "getManyOrgServiceAccounts", + "parameters": [ + { + "description": "The ID of the Snyk Organization that owns the service accounts.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "items": { + "additionalProperties": false, + "properties": { + "attributes": { + "properties": { + "access_token_ttl_seconds": { + "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", + "type": "number" + }, + "api_key": { + "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", + "type": "string" + }, + "auth_type": { + "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", + "enum": [ + "api_key", + "oauth_client_secret", + "oauth_private_key_jwt" + ], + "type": "string" + }, + "client_id": { + "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_client_secret or oauth_private_key_jwt.", + "type": "string" + }, + "client_secret": { + "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", + "type": "string" + }, + "jwks_url": { + "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", + "type": "string" + }, + "level": { + "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", + "enum": [ + "Group", + "Org" + ], + "type": "string" + }, + "name": { + "description": "A human-friendly name of the service account.", + "type": "string" + }, + "role_id": { + "description": "The ID of the role which the Service Account is associated with.", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "name", + "auth_type", + "role_id" + ], + "type": "object" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "properties": { + "first": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "last": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "next": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "prev": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "related": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "self": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "A list of service accounts is returned.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Get a list of organization service accounts.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-version": "2023-09-07" + }, + "post": { + "description": "Create a service account for an organization. The service account can be used to access the Snyk API.", + "operationId": "createOrgServiceAccount", + "parameters": [ + { + "description": "The ID of the Snyk Organization that is creating and will own the service account.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "additionalProperties": false, + "properties": { + "access_token_ttl_seconds": { + "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1 hour if unset. Only used when auth_type is one of the oauth_* variants.", + "maximum": 86400, + "minimum": 3600, + "type": "number" + }, + "auth_type": { + "description": "Authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out in OIDC Connect Core 1.0, section 9.", + "enum": [ + "api_key", + "oauth_client_secret", + "oauth_private_key_jwt" + ], + "type": "string" + }, + "jwks_url": { + "description": "A JWKs URL hosting your public keys, used to verify signed JWT requests. Must be https. Required only when auth_type is oauth_private_key_jwt.", + "type": "string" + }, + "name": { + "description": "A human-friendly name for the service account.", + "type": "string" + }, + "role_id": { + "description": "The ID of the role which the created service account should use. Obtained in the Snyk UI, via \"Group Page\" -\u003e \"Settings\" -\u003e \"Member Roles\" -\u003e \"Create new Role\". Can be shared among multiple accounts.", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "name", + "role_id", + "auth_type" + ], + "type": "object" + }, + "type": { + "description": "The Resource type.", + "enum": [ + "service_account" + ], + "type": "string" + } + }, + "required": [ + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "properties": { + "access_token_ttl_seconds": { + "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", + "type": "number" + }, + "api_key": { + "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", + "type": "string" + }, + "auth_type": { + "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", + "enum": [ + "api_key", + "oauth_client_secret", + "oauth_private_key_jwt" + ], + "type": "string" + }, + "client_id": { + "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_client_secret or oauth_private_key_jwt.", + "type": "string" + }, + "client_secret": { + "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", + "type": "string" + }, + "jwks_url": { + "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", + "type": "string" + }, + "level": { + "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", + "enum": [ + "Group", + "Org" + ], + "type": "string" + }, + "name": { + "description": "A human-friendly name of the service account.", + "type": "string" + }, + "role_id": { + "description": "The ID of the role which the Service Account is associated with.", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "name", + "auth_type", + "role_id" + ], + "type": "object" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "properties": { + "first": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "last": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "next": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "prev": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "related": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "self": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "A new service account has been created", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Create a service account for an organization.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-version": "2023-09-07" + }, + "x-snyk-api-resource": "service_accounts" + }, + "/orgs/{org_id}/service_accounts/{serviceaccount_id}": { + "delete": { + "description": "Delete a service account in an organization.", + "operationId": "deleteServiceAccount", + "parameters": [ + { + "description": "The ID of org to which the service account belongs.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "204": { + "description": "The service account has been deleted.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Delete a service account in an organization.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-version": "2023-09-07" + }, + "get": { + "description": "Get an organization-level service account by its ID.", + "operationId": "getOneOrgServiceAccount", + "parameters": [ + { + "description": "The ID of the Snyk Organization that owns the service account.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "properties": { + "access_token_ttl_seconds": { + "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", + "type": "number" + }, + "api_key": { + "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", + "type": "string" + }, + "auth_type": { + "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", + "enum": [ + "api_key", + "oauth_client_secret", + "oauth_private_key_jwt" + ], + "type": "string" + }, + "client_id": { + "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_client_secret or oauth_private_key_jwt.", + "type": "string" + }, + "client_secret": { + "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", + "type": "string" + }, + "jwks_url": { + "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", + "type": "string" + }, + "level": { + "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", + "enum": [ + "Group", + "Org" + ], + "type": "string" + }, + "name": { + "description": "A human-friendly name of the service account.", + "type": "string" + }, + "role_id": { + "description": "The ID of the role which the Service Account is associated with.", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "name", + "auth_type", + "role_id" + ], + "type": "object" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "properties": { + "first": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "last": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "next": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "prev": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "related": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "self": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "Service account is returned.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Get an organization service account.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-version": "2023-09-07" + }, + "patch": { + "description": "Update the name of an organization-level service account by its ID.", + "operationId": "updateOrgServiceAccount", + "parameters": [ + { + "description": "The ID of the Snyk Organization that owns the service account.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "additionalProperties": false, + "properties": { + "name": { + "description": "A human-friendly name for the service account. Must be unique within the organization.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "id": { + "description": "The ID of the service account. Must match the id in the url path.", + "format": "uuid", + "type": "string" + }, + "type": { + "description": "The Resource type.", + "enum": [ + "service_account" + ], + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "properties": { + "access_token_ttl_seconds": { + "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", + "type": "number" + }, + "api_key": { + "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", + "type": "string" + }, + "auth_type": { + "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", + "enum": [ + "api_key", + "oauth_client_secret", + "oauth_private_key_jwt" + ], + "type": "string" + }, + "client_id": { + "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_client_secret or oauth_private_key_jwt.", + "type": "string" + }, + "client_secret": { + "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", + "type": "string" + }, + "jwks_url": { + "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", + "type": "string" + }, + "level": { + "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", + "enum": [ + "Group", + "Org" + ], + "type": "string" + }, + "name": { + "description": "A human-friendly name of the service account.", + "type": "string" + }, + "role_id": { + "description": "The ID of the role which the Service Account is associated with.", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "name", + "auth_type", + "role_id" + ], + "type": "object" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "properties": { + "first": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "last": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "next": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "prev": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "related": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "self": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "Service account is returned.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Update an organization service account.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-version": "2023-09-07" + }, + "x-snyk-api-resource": "service_accounts" + }, + "/orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets": { + "post": { + "description": "Manage the client secret of an organization service account by the service account ID.", + "operationId": "updateOrgServiceAccountSecret", + "parameters": [ + { + "description": "The ID of the Snyk Organization that owns the service account.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The ID of the service account.", + "in": "path", + "name": "serviceaccount_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "$ref": "#/components/parameters/Version" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "additionalProperties": false, + "properties": { + "mode": { + "description": "Operation to perform:\n * `replace` - Replace existing secrets with a new generated secret.\n * `create` - Add a new secret, preserving existing secrets. A maximum of to two secrets can exist at a time.\n * `delete` - Remove an existing secret by value. At least one secret must remain per service account.\n", + "enum": [ + "replace", + "create", + "delete" + ], + "type": "string" + }, + "secret": { + "description": "Secret to delete when using `delete` mode", + "type": "string" + } + }, + "required": [ + "mode" + ], + "type": "object" + }, + "type": { + "description": "The Resource type.", + "enum": [ + "service_account" + ], + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "properties": { + "access_token_ttl_seconds": { + "description": "The time, in seconds, that a generated access token will be valid for. Defaults to 1hr if unset. Only provided when auth_type is oauth_private_key_jwt.", + "type": "number" + }, + "api_key": { + "description": "The Snyk API Key for this service account. Only returned on creation, and only when auth_type is api_key.", + "type": "string" + }, + "auth_type": { + "description": "The authentication strategy for the service account:\n * api_key - Regular Snyk API Key.\n * oauth_client_secret - OAuth2 client_credentials grant, which returns a client secret that can be used to retrieve an access token.\n * oauth_private_key_jwt - OAuth2 client_credentials grant, using private_key_jwt client_assertion as laid out OIDC Connect Core 1.0, section 9.", + "enum": [ + "api_key", + "oauth_client_secret", + "oauth_private_key_jwt" + ], + "type": "string" + }, + "client_id": { + "description": "The service account's attached client-id. Used to request an access-token. Only provided when auth_type is oauth_client_secret or oauth_private_key_jwt.", + "type": "string" + }, + "client_secret": { + "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", + "type": "string" + }, + "jwks_url": { + "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", + "type": "string" + }, + "level": { + "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", + "enum": [ + "Group", + "Org" + ], + "type": "string" + }, + "name": { + "description": "A human-friendly name of the service account.", + "type": "string" + }, + "role_id": { + "description": "The ID of the role which the Service Account is associated with.", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "name", + "auth_type", + "role_id" + ], + "type": "object" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "properties": { + "first": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "last": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "next": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "prev": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "related": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + }, + "self": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "attributes" + ], + "type": "object" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data" + ], + "type": "object" + } + } + }, + "description": "Service account client secret has been updated.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Manage an organization service account's client secret.", + "tags": [ + "ServiceAccounts" + ], + "x-snyk-api-releases": [ + "2023-09-07" + ], + "x-snyk-api-version": "2023-09-07" + }, + "x-snyk-api-resource": "service_accounts" + }, + "/orgs/{org_id}/settings/iac": { + "get": { + "description": "Get the Infrastructure as Code Settings for an org.", + "operationId": "getIacSettingsForOrg", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The id of the org whose Infrastructure as Code settings are requested.", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/OrgIacSettingsResponse" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "The Infrastructure as Code Settings of the org.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Get the Infrastructure as Code Settings for an org.", + "tags": [ + "IacSettings" + ], + "x-snyk-api-releases": [ + "2021-12-09" + ], + "x-snyk-api-version": "2021-12-09" + }, + "patch": { + "description": "Update the Infrastructure as Code Settings for an org.", + "operationId": "updateIacSettingsForOrg", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The id of the org whose Infrastructure as Code settings are getting updated", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "$ref": "#/components/schemas/OrgIacSettingsRequest" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/OrgIacSettingsResponse" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "The Infrastructure as Code Settings of the org were updated.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Update the Infrastructure as Code Settings for an org", + "tags": [ + "IacSettings" + ], + "x-snyk-api-releases": [ + "2021-12-09" + ], + "x-snyk-api-version": "2021-12-09" + }, + "x-snyk-api-resource": "iac_settings", + "x-snyk-resource-singleton": true + }, + "/orgs/{org_id}/settings/sast": { + "get": { + "description": "Retrieves the SAST settings for an org", + "operationId": "getSastSettings", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The id of the org for which we want to retrieve the SAST settings", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/SastEnablement" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "The SAST settings for the org are being retrieved", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Retrieves the SAST settings for an org", + "tags": [ + "SastSettings" + ], + "x-snyk-api-releases": [ + "2023-06-22" + ], + "x-snyk-api-version": "2023-06-22" + }, + "patch": { + "description": "Enable/Disable the Snyk Code settings for an org", + "operationId": "updateOrgSastSettings", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "description": "The id of the org for which we want to update the Snyk Code setting", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "additionalProperties": false, + "properties": { + "attributes": { + "additionalProperties": false, + "properties": { + "sast_enabled": { + "description": "The value of the updated settings for sastEnabled setting", + "type": "boolean" + } + }, + "required": [ + "sast_enabled" + ], + "type": "object" + }, + "id": { + "format": "uuid", + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/SastEnablement" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "The SAST settings for the org are being updated", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Enable/Disable the Snyk Code settings for an org", + "tags": [ + "SastSettings" + ], + "x-snyk-api-releases": [ + "2023-08-24~experimental", + "2023-09-11" + ], + "x-snyk-api-version": "2023-09-11" + }, + "x-snyk-api-resource": "sast_settings", + "x-snyk-resource-singleton": true + }, + "/orgs/{org_id}/slack_app/{bot_id}": { + "delete": { + "description": "Remove the given Slack App integration", + "operationId": "deleteSlackDefaultNotificationSettings", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/BotId" + } + ], + "responses": { + "204": { + "description": "Slack App integration successfully removed", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "409": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Remove the given Slack App integration", + "tags": [ + "SlackSettings" + ], + "x-snyk-api-releases": [ + "2022-11-07~experimental", + "2022-12-14" + ], + "x-snyk-api-version": "2022-12-14" + }, + "get": { + "description": "Get Slack integration default notification settings for the provided tenant ID and bot ID.", + "operationId": "getSlackDefaultNotificationSettings", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/BotId" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/SlackDefaultSettingsData" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" + } + }, + "type": "object" + } + } + }, + "description": "Default settings created successfully", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "409": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Get Slack integration default notification settings.", + "tags": [ + "SlackSettings" + ], + "x-snyk-api-releases": [ + "2022-11-07~experimental", + "2022-12-14" + ], + "x-snyk-api-version": "2022-12-14" + }, + "post": { + "description": "Create new Slack notification default settings for a given tenant.", + "operationId": "createSlackDefaultNotificationSettings", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/BotId" + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/SettingsRequest" + } + } + }, + "description": "Create new Slack notification default settings for a tenant." + }, + "responses": { + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/SlackDefaultSettingsData" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" + } + }, + "type": "object" + } + } + }, + "description": "Default settings created successfully", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "409": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + } + }, + "summary": "Create new Slack notification default settings.", + "tags": [ + "SlackSettings" + ], + "x-snyk-api-releases": [ + "2022-11-07~experimental", + "2022-12-14" + ], + "x-snyk-api-version": "2022-12-14" + }, + "x-snyk-api-resource": "settings" + }, + "/orgs/{org_id}/slack_app/{bot_id}/projects": { + "get": { + "description": "Slack notification settings overrides for projects. These settings overrides the default settings configured for the tenant.", + "operationId": "getSlackProjectNotificationSettingsCollection", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/BotId" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/GetProjectSettingsCollection" + } + } + }, + "description": "Return default settings for a tenant", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "403": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } }, - "client_secret": { - "description": "The client secret used for obtaining access tokens. Only sent on creation of new service accounts and cannot be retrieved thereafter. Only provided when auth_type is oauth_client_secret.", - "type": "string" + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" }, - "jwks_url": { - "description": "A JWKs URL used to verify signed JWT requests against. Must be https. Only provided when auth_type is oauth_private_key_jwt.", - "type": "string" + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" }, - "level": { - "description": "The level of access for the service account:\n * Group - the service account was created at the Group level.\n * Org - the service account was created at the Org level.", - "enum": [ - "Group", - "Org" - ], - "type": "string" + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } }, - "name": { - "description": "A human-friendly name of the service account.", - "type": "string" + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "404": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found: The resource being operated on could not be found.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "409": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } }, - "role_id": { - "description": "The ID of the role which the Service Account is associated with.", - "format": "uuid", - "type": "string" - } + "type": "object" }, - "required": [ - "name", - "auth_type", - "role_id" - ], - "type": "object" + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } }, - "id": { - "format": "uuid", + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "500": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" }, - "links": { - "additionalProperties": false, - "properties": { - "first": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" }, - "last": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "next": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - }, - "prev": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" + "type": "object" + } }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "required": [ + "href" + ], + "type": "object" + } + ] + } }, - "related": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" }, - "self": { - "example": "https://example.com/api/resource", - "oneOf": [ - { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - { - "additionalProperties": false, - "example": { - "href": "https://example.com/api/resource" - }, - "properties": { - "href": { - "description": "A string containing the link’s URL.", - "example": "https://example.com/api/resource", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "description": "Free-form object that may contain non-standard information.", - "example": { - "key1": "value1", - "key2": { - "sub_key": "sub_value" - }, - "key3": [ - "array_value1", - "array_value2" - ] - }, - "type": "object" - } - }, - "required": [ - "href" - ], - "type": "object" - } - ] - } + "type": "object" }, - "type": "object" + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } }, - "type": { + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", "type": "string" } }, "required": [ - "type", - "id", - "attributes" + "version" ], "type": "object" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" } }, "required": [ "jsonapi", - "data" + "errors" ], "type": "object" } } }, - "description": "Service account client secret has been updated.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" } }, - "summary": "Manage an organization service account's client secret.", + "summary": "Slack notification settings overrides for projects", "tags": [ - "ServiceAccounts" + "SlackSettings" ], "x-snyk-api-releases": [ - "2023-09-07" + "2022-11-07~experimental", + "2022-12-14" ], - "x-snyk-api-version": "2023-09-07" + "x-snyk-api-version": "2022-12-14" }, - "x-snyk-api-resource": "service_accounts" + "x-snyk-api-resource": "settings" }, - "/orgs/{org_id}/settings/iac": { - "get": { - "description": "Get the Infrastructure as Code Settings for an org.", - "operationId": "getIacSettingsForOrg", + "/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}": { + "delete": { + "description": "Remove Slack settings override for a project.", + "operationId": "deleteSlackProjectNotificationSettings", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "description": "The id of the org whose Infrastructure as Code settings are requested.", + "$ref": "#/components/parameters/OrgId" + }, + { + "description": "Project ID", "in": "path", - "name": "org_id", + "name": "project_id", "required": true, "schema": { "format": "uuid", "type": "string" } + }, + { + "$ref": "#/components/parameters/BotId" } ], "responses": { - "200": { + "204": { + "description": "Slack settings override for the project removed successfully.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "$ref": "#/components/schemas/OrgIacSettingsResponse" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } + } + }, + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "The Infrastructure as Code Settings of the org.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get the Infrastructure as Code Settings for an org.", - "tags": [ - "IacSettings" - ], - "x-snyk-api-releases": [ - "2021-12-09" - ], - "x-snyk-api-version": "2021-12-09" - }, - "patch": { - "description": "Update the Infrastructure as Code Settings for an org.", - "operationId": "updateIacSettingsForOrg", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the org whose Infrastructure as Code settings are getting updated", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "properties": { - "data": { - "$ref": "#/components/schemas/OrgIacSettingsRequest" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "content": { - "application/vnd.api+json": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", "schema": { - "additionalProperties": false, - "properties": { - "data": { - "$ref": "#/components/schemas/OrgIacSettingsResponse" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - } - }, - "required": [ - "jsonapi", - "data", - "links" + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" ], - "type": "object" + "example": "ga", + "type": "string" } - } - }, - "description": "The Infrastructure as Code Settings of the org were updated.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Update the Infrastructure as Code Settings for an org", - "tags": [ - "IacSettings" - ], - "x-snyk-api-releases": [ - "2021-12-09" - ], - "x-snyk-api-version": "2021-12-09" - }, - "x-snyk-api-resource": "iac_settings", - "x-snyk-resource-singleton": true - }, - "/orgs/{org_id}/settings/sast": { - "get": { - "description": "Retrieves the SAST settings for an org", - "operationId": "getSastSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the org for which we want to retrieve the SAST settings", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "$ref": "#/components/schemas/SastEnablement" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "The SAST settings for the org are being retrieved", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Retrieves the SAST settings for an org", - "tags": [ - "SastSettings" - ], - "x-snyk-api-releases": [ - "2023-06-22" - ], - "x-snyk-api-version": "2023-06-22" - }, - "patch": { - "description": "Enable/Disable the Snyk Code settings for an org", - "operationId": "updateOrgSastSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the org for which we want to update the Snyk Code setting", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "additionalProperties": false, - "properties": { - "attributes": { - "additionalProperties": false, - "properties": { - "sast_enabled": { - "description": "The value of the updated settings for sastEnabled setting", - "type": "boolean" - } - }, - "required": [ - "sast_enabled" - ], - "type": "object" - }, - "id": { - "format": "uuid", - "type": "string" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "type", - "attributes" - ], - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "required": true - }, - "responses": { - "201": { + "404": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "$ref": "#/components/schemas/SastEnablement" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "The SAST settings for the org are being updated", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Enable/Disable the Snyk Code settings for an org", - "tags": [ - "SastSettings" - ], - "x-snyk-api-releases": [ - "2023-08-24~experimental", - "2023-09-11" - ], - "x-snyk-api-version": "2023-09-11" - }, - "x-snyk-api-resource": "sast_settings", - "x-snyk-resource-singleton": true - }, - "/orgs/{org_id}/slack_app/{bot_id}": { - "delete": { - "description": "Remove the given Slack App integration", - "operationId": "deleteSlackDefaultNotificationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/BotId" - } - ], - "responses": { - "204": { - "description": "Slack App integration successfully removed", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Remove the given Slack App integration", - "tags": [ - "SlackSettings" - ], - "x-snyk-api-releases": [ - "2022-11-07~experimental", - "2022-12-14" - ], - "x-snyk-api-version": "2022-12-14" - }, - "get": { - "description": "Get Slack integration default notification settings for the provided tenant ID and bot ID.", - "operationId": "getSlackDefaultNotificationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/BotId" - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "$ref": "#/components/schemas/SlackDefaultSettingsData" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, + "required": [ + "jsonapi", + "errors" + ], "type": "object" } } }, - "description": "Default settings created successfully", + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get Slack integration default notification settings.", - "tags": [ - "SlackSettings" - ], - "x-snyk-api-releases": [ - "2022-11-07~experimental", - "2022-12-14" - ], - "x-snyk-api-version": "2022-12-14" - }, - "post": { - "description": "Create new Slack notification default settings for a given tenant.", - "operationId": "createSlackDefaultNotificationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/BotId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/SettingsRequest" - } - } - }, - "description": "Create new Slack notification default settings for a tenant." - }, - "responses": { - "201": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "$ref": "#/components/schemas/SlackDefaultSettingsData" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, + "required": [ + "jsonapi", + "errors" + ], "type": "object" } } }, - "description": "Default settings created successfully", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Create new Slack notification default settings.", - "tags": [ - "SlackSettings" - ], - "x-snyk-api-releases": [ - "2022-11-07~experimental", - "2022-12-14" - ], - "x-snyk-api-version": "2022-12-14" - }, - "x-snyk-api-resource": "settings" - }, - "/orgs/{org_id}/slack_app/{bot_id}/projects": { - "get": { - "description": "Slack notification settings overrides for projects. These settings overrides the default settings configured for the tenant.", - "operationId": "getSlackProjectNotificationSettingsCollection", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/BotId" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", "schema": { - "$ref": "#/components/schemas/GetProjectSettingsCollection" + "format": "date-time", + "type": "string" } - } - }, - "description": "Return default settings for a tenant", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Slack notification settings overrides for projects", - "tags": [ - "SlackSettings" - ], - "x-snyk-api-releases": [ - "2022-11-07~experimental", - "2022-12-14" - ], - "x-snyk-api-version": "2022-12-14" - }, - "x-snyk-api-resource": "settings" - }, - "/orgs/{org_id}/slack_app/{bot_id}/projects/{project_id}": { - "delete": { - "description": "Remove Slack settings override for a project.", - "operationId": "deleteSlackProjectNotificationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Project ID", - "in": "path", - "name": "project_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/BotId" - } - ], - "responses": { - "204": { - "description": "Slack settings override for the project removed successfully.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" } }, "summary": "Remove Slack settings override for a project.", @@ -46566,14 +91138,7 @@ "$ref": "#/components/parameters/Version" }, { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/OrgId" }, { "$ref": "#/components/parameters/BotId" @@ -46643,631 +91208,1483 @@ } }, "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Update Slack notification settings for a project.", - "tags": [ - "SlackSettings" - ], - "x-snyk-api-releases": [ - "2022-11-07~experimental", - "2022-12-14" - ], - "x-snyk-api-version": "2022-12-14" - }, - "post": { - "description": "Create Slack settings override for a project.", - "operationId": "createSlackProjectNotificationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Project ID", - "in": "path", - "name": "project_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + } } }, - { - "$ref": "#/components/parameters/BotId" - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/SettingsRequest" + "401": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, + "properties": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" + }, + "jsonapi": { + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" + } + }, + "required": [ + "jsonapi", + "errors" + ], + "type": "object" + } + } + }, + "description": "Unauthorized: the request requires an authentication token.", + "headers": { + "deprecation": { + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } + }, + "snyk-request-id": { + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } + }, + "snyk-version-lifecycle-stage": { + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } + }, + "snyk-version-requested": { + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } + }, + "snyk-version-served": { + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } + }, + "sunset": { + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "description": "Create new Slack notification default settings for a tenant." - }, - "responses": { - "201": { + "403": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "$ref": "#/components/schemas/ProjectSettingsData" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, + "required": [ + "jsonapi", + "errors" + ], "type": "object" } } }, - "description": "Project settings created successfully", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "$ref": "#/components/headers/LocationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Create a new Slack settings override for a given project.", - "tags": [ - "SlackSettings" - ], - "x-snyk-api-releases": [ - "2022-11-07~experimental", - "2022-12-14" - ], - "x-snyk-api-version": "2022-12-14" - }, - "x-snyk-api-resource": "settings" - }, - "/orgs/{org_id}/slack_app/{tenant_id}/channels": { - "get": { - "description": "Requires the Snyk Slack App to be set up for this org, will retrieve a list of channels the Snyk Slack App can access. Note that it is currently only possible to page forwards through this collection, no prev links will be generated and the ending_before parameter will not function.", - "operationId": "listChannels", - "parameters": [ - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/ChannelLimit" - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/TenantId" - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], "items": { - "$ref": "#/components/schemas/SlackChannel" + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" }, + "minItems": 1, "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ - "data", "jsonapi", - "links" + "errors" ], "type": "object" } } }, - "description": "List of Slack channels", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, "409": { - "$ref": "#/components/responses/409" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get a list of Slack channels", - "tags": [ - "Slack" - ], - "x-snyk-api-releases": [ - "2022-11-07" - ], - "x-snyk-api-version": "2022-11-07" - }, - "x-snyk-api-resource": "channels" - }, - "/orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id}": { - "get": { - "description": "Requires the Snyk Slack App to be set up for this org. It will return the Slack channel name for the provided Slack channel ID.", - "operationId": "getChannelNameById", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "Org ID", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/ChannelId" - }, - { - "$ref": "#/components/parameters/TenantId" - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "$ref": "#/components/schemas/SlackChannel" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/SelfLink" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ - "data", "jsonapi", - "links" + "errors" ], "type": "object" } } }, - "description": "List of Slack channels", + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "409": { - "$ref": "#/components/responses/409" - }, "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get Slack Channel name by Slack Channel ID.", - "tags": [ - "Slack" - ], - "x-snyk-api-releases": [ - "2022-11-07" - ], - "x-snyk-api-version": "2022-11-07" - }, - "x-snyk-api-resource": "channels" - }, - "/orgs/{org_id}/targets": { - "get": { - "description": "Get a list of an organization's targets.", - "operationId": "getOrgsTargets", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "description": "Calculate total amount of filtered results", - "in": "query", - "name": "count", - "schema": { - "type": "boolean" - } - }, - { - "description": "Number of results to return per page", - "example": 10, - "in": "query", - "name": "limit", - "schema": { - "default": 10, - "format": "int32", - "maximum": 100, - "minimum": 1, - "type": "integer" - } - }, - { - "description": "The id of the org to return a list of targets", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "Return targets that match the provided value of is_private", - "in": "query", - "name": "is_private", - "schema": { - "type": "boolean" - } - }, - { - "description": "Return only the targets that has projects", - "in": "query", - "name": "exclude_empty", - "schema": { - "default": true, - "type": "boolean" - } - }, - { - "description": "Return targets that match the provided remote_url.", - "in": "query", - "name": "url", - "schema": { - "type": "string" - } - }, - { - "description": "Return targets that match the provided source_types", - "explode": false, - "in": "query", - "name": "source_types", - "schema": { - "items": { - "enum": [ - "bitbucket-server", - "gitlab", - "github-enterprise", - "bitbucket-cloud", - "bitbucket-connect-app", - "azure-repos", - "github", - "github-cloud-app", - "github-server-app", - "cli", - "docker-hub", - "in-memory-fs", - "acr", - "ecr", - "gcr", - "artifactory-cr", - "harbor-cr", - "quay-cr", - "github-cr", - "nexus-cr", - "nexus-private-repo", - "digitalocean-cr", - "gitlab-cr", - "google-artifact-cr", - "heroku", - "kubernetes", - "api", - "aws-lambda", - "azure-functions", - "cloud-foundry", - "pivotal", - "ibm-cloud", - "terraform-cloud" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return targets with display names starting with the provided string", - "in": "query", - "name": "display_name", - "schema": { - "type": "string" - } - }, - { - "description": "Return only targets which have been created at or after the specified date.\n", - "example": "2022-01-01T16:00:00Z", - "in": "query", - "name": "created_gte", - "schema": { - "format": "date-time", - "type": "string" - } - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], "items": { - "$ref": "#/components/schemas/PublicTarget" + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" }, + "minItems": 1, "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" - }, - "meta": { "additionalProperties": false, "example": { - "count": 3 + "version": "1.0" }, "properties": { - "count": { - "type": "number" + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" } }, + "required": [ + "version" + ], "type": "object" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "A list of targets is returned for the targeted org", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" } }, - "summary": "Get targets by org ID", + "summary": "Update Slack notification settings for a project.", "tags": [ - "Targets" + "SlackSettings" ], "x-snyk-api-releases": [ - "2021-08-20~beta", - "2024-02-21" + "2022-11-07~experimental", + "2022-12-14" ], - "x-snyk-api-version": "2024-02-21" + "x-snyk-api-version": "2022-12-14" }, - "x-snyk-api-resource": "targets" - }, - "/orgs/{org_id}/targets/{target_id}": { - "delete": { - "description": "Delete the specified target.", - "operationId": "deleteOrgsTarget", + "post": { + "description": "Create Slack settings override for a project.", + "operationId": "createSlackProjectNotificationSettings", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "description": "The id of the org to delete", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/parameters/OrgId" }, { - "description": "The id of the target to delete", + "description": "Project ID", "in": "path", - "name": "target_id", + "name": "project_id", "required": true, "schema": { "format": "uuid", "type": "string" } + }, + { + "$ref": "#/components/parameters/BotId" } ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/SettingsRequest" + } + } + }, + "description": "Create new Slack notification default settings for a tenant." + }, "responses": { - "204": { - "description": "The target is deleted with all projects, if it is found in the specified org.", + "201": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/ProjectSettingsData" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" + } + }, + "type": "object" + } + } + }, + "description": "Project settings created successfully", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" }, + "location": { + "$ref": "#/components/headers/LocationHeader" + }, "snyk-request-id": { "$ref": "#/components/headers/RequestIdResponseHeader" }, @@ -47286,285 +92703,708 @@ } }, "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Delete target by target ID", - "tags": [ - "Targets" - ], - "x-snyk-api-releases": [ - "2021-09-29~beta", - "2023-06-23~beta", - "2024-02-21" - ], - "x-snyk-api-version": "2024-02-21" - }, - "get": { - "description": "Get a specified target for an organization.", - "operationId": "getOrgsTarget", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "description": "The id of the org to return the target from", - "in": "path", - "name": "org_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - }, - { - "description": "The id of the target to return", - "in": "path", - "name": "target_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "$ref": "#/components/schemas/PublicTarget" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ "jsonapi", - "data" + "errors" ], "type": "object" } } }, - "description": "A single target is returned if it is found in the specified org", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { - "$ref": "#/components/responses/401" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "Get target by target ID", - "tags": [ - "Targets" - ], - "x-snyk-api-releases": [ - "2021-08-20~beta", - "2024-02-21" - ], - "x-snyk-api-version": "2024-02-21" - }, - "x-snyk-api-resource": "targets" - }, - "/self": { - "get": { - "description": "Retrieves information about the the user making the request.", - "operationId": "getSelf", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { + "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { - "$ref": "#/components/schemas/Principal" + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "items": { + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" + }, + "minItems": 1, + "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/Links" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ "jsonapi", - "data", - "links" + "errors" ], "type": "object" } } }, - "description": "Current user is returned", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "500": { - "$ref": "#/components/responses/500" - } - }, - "summary": "My User Details", - "tags": [ - "Users" - ], - "x-snyk-api-releases": [ - "2022-03-01~experimental", - "2022-09-14~experimental", - "2024-04-22" - ], - "x-snyk-api-version": "2024-04-22" - }, - "x-snyk-api-resource": "self", - "x-snyk-resource-singleton": true - }, - "/self/apps": { - "get": { - "description": "Get a list of apps that can act on your behalf.", - "operationId": "getUserInstalledApps", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, + "example": { + "errors": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], + "jsonapi": { + "version": "1.0" + } + }, "properties": { - "data": { + "errors": { + "example": [ + { + "detail": "Permission denied for this resource", + "status": "403" + } + ], "items": { - "$ref": "#/components/schemas/PublicApp" + "additionalProperties": false, + "example": { + "detail": "Not Found", + "status": "404" + }, + "properties": { + "code": { + "description": "An application-specific error code, expressed as a string value.", + "example": "entity-not-found", + "type": "string" + }, + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem.", + "example": "The request was missing these required fields: ...", + "type": "string" + }, + "id": { + "description": "A unique identifier for this particular occurrence of the problem.", + "example": "f16c31b5-6129-4571-add8-d589da9be524", + "format": "uuid", + "type": "string" + }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, + "meta": { + "additionalProperties": true, + "example": { + "key": "value" + }, + "type": "object" + }, + "source": { + "additionalProperties": false, + "example": { + "pointer": "/data/attributes" + }, + "properties": { + "parameter": { + "description": "A string indicating which URI query parameter caused the error.", + "example": "param1", + "type": "string" + }, + "pointer": { + "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", + "example": "/data/attributes", + "type": "string" + } + }, + "type": "object" + }, + "status": { + "description": "The HTTP status code applicable to this problem, expressed as a string value.", + "example": "400", + "pattern": "^[45]\\d\\d$", + "type": "string" + }, + "title": { + "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", + "example": "Bad request", + "type": "string" + } + }, + "required": [ + "status", + "detail" + ], + "type": "object" }, + "minItems": 1, "type": "array" }, "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" + "additionalProperties": false, + "example": { + "version": "1.0" + }, + "properties": { + "version": { + "description": "Version of the JSON API specification this server supports.", + "example": "1.0", + "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", + "type": "string" + } + }, + "required": [ + "version" + ], + "type": "object" } }, "required": [ - "data", "jsonapi", - "links" + "errors" ], "type": "object" } } }, - "description": "A list of apps install that can act on your behalf", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" + "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", + "example": "2021-07-01T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } }, "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" + "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", + "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", + "schema": { + "format": "uuid", + "type": "string" + } }, "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" + "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", + "schema": { + "enum": [ + "wip", + "experimental", + "beta", + "ga", + "deprecated", + "sunset" + ], + "example": "ga", + "type": "string" + } }, "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" + "description": "A header containing the version of the endpoint requested by the caller.", + "example": "2021-06-04", + "schema": { + "description": "Requested API version", + "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", + "type": "string" + } }, "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" + "description": "A header containing the version of the endpoint that was served by the API.", + "example": "2021-06-04", + "schema": { + "description": "Resolved API version", + "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", + "type": "string" + } }, "sunset": { - "$ref": "#/components/headers/SunsetHeader" + "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", + "example": "2021-08-02T00:00:00Z", + "schema": { + "format": "date-time", + "type": "string" + } } } }, - "400": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -47611,6 +93451,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -47685,7 +93577,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -47746,7 +93638,7 @@ } } }, - "401": { + "409": { "content": { "application/vnd.api+json": { "schema": { @@ -47793,6 +93685,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -47867,7 +93811,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -47928,7 +93872,7 @@ } } }, - "403": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -47975,6 +93919,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -48049,7 +94045,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -48109,8 +94105,96 @@ } } } + } + }, + "summary": "Create a new Slack settings override for a given project.", + "tags": [ + "SlackSettings" + ], + "x-snyk-api-releases": [ + "2022-11-07~experimental", + "2022-12-14" + ], + "x-snyk-api-version": "2022-12-14" + }, + "x-snyk-api-resource": "settings" + }, + "/orgs/{org_id}/slack_app/{tenant_id}/channels": { + "get": { + "description": "Requires the Snyk Slack App to be set up for this org, will retrieve a list of channels the Snyk Slack App can access. Note that it is currently only possible to page forwards through this collection, no prev links will be generated and the ending_before parameter will not function.", + "operationId": "listChannels", + "parameters": [ + { + "$ref": "#/components/parameters/StartingAfter" }, - "404": { + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/ChannelLimit" + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/TenantId" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/SlackChannel" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" + } + }, + "required": [ + "data", + "jsonapi", + "links" + ], + "type": "object" + } + } + }, + "description": "List of Slack channels", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -48157,6 +94241,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -48231,7 +94367,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -48292,7 +94428,7 @@ } } }, - "409": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -48339,6 +94475,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -48413,7 +94601,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -48474,7 +94662,7 @@ } } }, - "500": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -48521,6 +94709,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -48595,7 +94835,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -48655,105 +94895,8 @@ } } } - } - }, - "summary": "Get a list of apps that can act on your behalf.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2022-03-11" - ], - "x-snyk-api-version": "2022-03-11" - }, - "x-snyk-api-resource": "user_app_installs" - }, - "/self/apps/installs": { - "get": { - "description": "Get a list of apps installed for an user.", - "operationId": "getAppInstallsForUser", - "parameters": [ - { - "description": "Expand relationships.", - "explode": false, - "in": "query", - "name": "expand", - "schema": { - "items": { - "enum": [ - "app" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" - } - ], - "responses": { - "200": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/AppInstallData" - }, - "type": "array" - }, - "jsonapi": { - "$ref": "#/components/schemas/JsonApi" - }, - "links": { - "$ref": "#/components/schemas/PaginatedLinks" - } - }, - "required": [ - "data", - "jsonapi", - "links" - ], - "type": "object" - } - } - }, - "description": "A list of apps installed for the specified organization.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } }, - "400": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -48800,6 +94943,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -48874,7 +95069,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -48935,7 +95130,7 @@ } } }, - "401": { + "409": { "content": { "application/vnd.api+json": { "schema": { @@ -48982,6 +95177,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -49056,7 +95303,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -49117,7 +95364,7 @@ } } }, - "403": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -49164,6 +95411,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -49238,7 +95537,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -49298,8 +95597,86 @@ } } } + } + }, + "summary": "Get a list of Slack channels", + "tags": [ + "Slack" + ], + "x-snyk-api-releases": [ + "2022-11-07" + ], + "x-snyk-api-version": "2022-11-07" + }, + "x-snyk-api-resource": "channels" + }, + "/orgs/{org_id}/slack_app/{tenant_id}/channels/{channel_id}": { + "get": { + "description": "Requires the Snyk Slack App to be set up for this org. It will return the Slack channel name for the provided Slack channel ID.", + "operationId": "getChannelNameById", + "parameters": [ + { + "$ref": "#/components/parameters/Version" }, - "404": { + { + "$ref": "#/components/parameters/OrgId" + }, + { + "$ref": "#/components/parameters/ChannelId" + }, + { + "$ref": "#/components/parameters/TenantId" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "$ref": "#/components/schemas/SlackChannel" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/SelfLink" + } + }, + "required": [ + "data", + "jsonapi", + "links" + ], + "type": "object" + } + } + }, + "description": "List of Slack channels", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -49346,6 +95723,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -49420,7 +95849,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -49481,7 +95910,7 @@ } } }, - "409": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -49528,6 +95957,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -49602,7 +96083,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -49663,7 +96144,7 @@ } } }, - "500": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -49710,6 +96191,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -49784,7 +96317,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -49844,62 +96377,8 @@ } } } - } - }, - "summary": "Get a list of apps installed for an user.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "app_installs" - }, - "/self/apps/installs/{install_id}": { - "delete": { - "description": "Revoke access for an app by install ID.", - "operationId": "deleteUserAppInstallByID", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/InstallId" - } - ], - "responses": { - "204": { - "description": "The app install has been revoked.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } }, - "400": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -49946,6 +96425,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -50020,7 +96551,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -50081,7 +96612,7 @@ } } }, - "401": { + "409": { "content": { "application/vnd.api+json": { "schema": { @@ -50128,6 +96659,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -50202,7 +96785,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -50263,7 +96846,7 @@ } } }, - "403": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -50310,6 +96893,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -50384,7 +97019,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -50444,8 +97079,220 @@ } } } + } + }, + "summary": "Get Slack Channel name by Slack Channel ID.", + "tags": [ + "Slack" + ], + "x-snyk-api-releases": [ + "2022-11-07" + ], + "x-snyk-api-version": "2022-11-07" + }, + "x-snyk-api-resource": "channels" + }, + "/orgs/{org_id}/targets": { + "get": { + "description": "Get a list of an organization's targets.", + "operationId": "getOrgsTargets", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "description": "Calculate total amount of filtered results", + "in": "query", + "name": "count", + "schema": { + "type": "boolean" + } + }, + { + "description": "Number of results to return per page", + "example": 10, + "in": "query", + "name": "limit", + "schema": { + "default": 10, + "format": "int32", + "maximum": 100, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "The id of the org to return a list of targets", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "Return targets that match the provided value of is_private", + "in": "query", + "name": "is_private", + "schema": { + "type": "boolean" + } + }, + { + "description": "Return only the targets that has projects", + "in": "query", + "name": "exclude_empty", + "schema": { + "default": true, + "type": "boolean" + } + }, + { + "description": "Return targets that match the provided remote_url.", + "in": "query", + "name": "url", + "schema": { + "type": "string" + } + }, + { + "description": "Return targets that match the provided source_types", + "explode": false, + "in": "query", + "name": "source_types", + "schema": { + "items": { + "enum": [ + "bitbucket-server", + "gitlab", + "github-enterprise", + "bitbucket-cloud", + "bitbucket-connect-app", + "azure-repos", + "github", + "github-cloud-app", + "github-server-app", + "cli", + "docker-hub", + "in-memory-fs", + "acr", + "ecr", + "gcr", + "artifactory-cr", + "harbor-cr", + "quay-cr", + "github-cr", + "nexus-cr", + "nexus-private-repo", + "digitalocean-cr", + "gitlab-cr", + "google-artifact-cr", + "heroku", + "kubernetes", + "api", + "aws-lambda", + "azure-functions", + "cloud-foundry", + "pivotal", + "ibm-cloud", + "terraform-cloud" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Return targets with display names starting with the provided string", + "in": "query", + "name": "display_name", + "schema": { + "type": "string" + } + }, + { + "description": "Return only targets which have been created at or after the specified date.\n", + "example": "2022-01-01T16:00:00Z", + "in": "query", + "name": "created_gte", + "schema": { + "format": "date-time", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/PublicTarget" + }, + "type": "array" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + }, + "meta": { + "additionalProperties": false, + "example": { + "count": 3 + }, + "properties": { + "count": { + "type": "number" + } + }, + "type": "object" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "A list of targets is returned for the targeted org", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } }, - "404": { + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -50492,6 +97339,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -50566,7 +97465,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -50627,7 +97526,7 @@ } } }, - "409": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -50674,6 +97573,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -50748,7 +97699,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -50809,7 +97760,7 @@ } } }, - "500": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -50856,6 +97807,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -50930,7 +97933,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -50990,62 +97993,8 @@ } } } - } - }, - "summary": "Revoke access for an app by install ID.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-06-19~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "app_installs" - }, - "/self/apps/{app_id}": { - "delete": { - "description": "Revoke access for an app by app id", - "operationId": "revokeUserInstalledApp", - "parameters": [ - { - "$ref": "#/components/parameters/Version" }, - { - "$ref": "#/components/parameters/AppId" - } - ], - "responses": { - "204": { - "description": "The app has been revoked", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } - }, - "400": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -51092,6 +98041,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -51166,7 +98167,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -51227,7 +98228,7 @@ } } }, - "401": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -51274,6 +98275,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -51348,7 +98401,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -51408,8 +98461,74 @@ } } } + } + }, + "summary": "Get targets by org ID", + "tags": [ + "Targets" + ], + "x-snyk-api-releases": [ + "2021-08-20~beta", + "2024-02-21" + ], + "x-snyk-api-version": "2024-02-21" + }, + "x-snyk-api-resource": "targets" + }, + "/orgs/{org_id}/targets/{target_id}": { + "delete": { + "description": "Delete the specified target.", + "operationId": "deleteOrgsTarget", + "parameters": [ + { + "$ref": "#/components/parameters/Version" }, - "403": { + { + "description": "The id of the org to delete", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + }, + { + "description": "The id of the target to delete", + "in": "path", + "name": "target_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The target is deleted with all projects, if it is found in the specified org.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -51456,6 +98575,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -51530,7 +98701,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -51591,7 +98762,7 @@ } } }, - "404": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -51638,6 +98809,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -51712,7 +98935,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -51773,7 +98996,7 @@ } } }, - "409": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -51820,6 +99043,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -51894,7 +99169,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -52002,6 +99277,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -52138,36 +99465,43 @@ } } }, - "summary": "Revoke an app", + "summary": "Delete target by target ID", "tags": [ - "Apps" + "Targets" ], "x-snyk-api-releases": [ - "2022-03-11" + "2021-09-29~beta", + "2023-06-23~beta", + "2024-02-21" ], - "x-snyk-api-version": "2022-03-11" + "x-snyk-api-version": "2024-02-21" }, - "x-snyk-api-resource": "user_app_installs" - }, - "/self/apps/{app_id}/sessions": { "get": { - "description": "Get a list of active OAuth sessions for the app.", - "operationId": "getUserAppSessions", + "description": "Get a specified target for an organization.", + "operationId": "getOrgsTarget", "parameters": [ { "$ref": "#/components/parameters/Version" }, { - "$ref": "#/components/parameters/StartingAfter" - }, - { - "$ref": "#/components/parameters/EndingBefore" - }, - { - "$ref": "#/components/parameters/Limit" + "description": "The id of the org to return the target from", + "in": "path", + "name": "org_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } }, { - "$ref": "#/components/parameters/AppId" + "description": "The id of the target to return", + "in": "path", + "name": "target_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } } ], "responses": { @@ -52178,27 +99512,24 @@ "additionalProperties": false, "properties": { "data": { - "items": { - "$ref": "#/components/schemas/SessionData" - }, - "type": "array" + "$ref": "#/components/schemas/PublicTarget" }, "jsonapi": { "$ref": "#/components/schemas/JsonApi" }, "links": { - "$ref": "#/components/schemas/PaginatedLinks" + "$ref": "#/components/schemas/Links" } }, "required": [ - "data", - "jsonapi" + "jsonapi", + "data" ], "type": "object" } } }, - "description": "A list of active OAuth sessions for the app.", + "description": "A single target is returned if it is found in the specified org", "headers": { "deprecation": { "$ref": "#/components/headers/DeprecationHeader" @@ -52267,6 +99598,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -52449,6 +99832,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -52523,7 +99958,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -52584,7 +100019,7 @@ } } }, - "403": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -52631,6 +100066,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -52705,7 +100192,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -52766,7 +100253,7 @@ } } }, - "404": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -52813,6 +100300,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -52887,7 +100426,7 @@ } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -52947,8 +100486,77 @@ } } } + } + }, + "summary": "Get target by target ID", + "tags": [ + "Targets" + ], + "x-snyk-api-releases": [ + "2021-08-20~beta", + "2024-02-21" + ], + "x-snyk-api-version": "2024-02-21" + }, + "x-snyk-api-resource": "targets" + }, + "/self": { + "get": { + "description": "Retrieves information about the the user making the request.", + "operationId": "getSelf", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "properties": { + "data": { + "$ref": "#/components/schemas/Principal" + }, + "jsonapi": { + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/Links" + } + }, + "required": [ + "jsonapi", + "data", + "links" + ], + "type": "object" + } + } + }, + "description": "Current user is returned", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } }, - "409": { + "400": { "content": { "application/vnd.api+json": { "schema": { @@ -52995,6 +100603,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -53069,7 +100729,7 @@ } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "Bad Request: A parameter provided as a part of the request was invalid.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -53130,7 +100790,7 @@ } } }, - "500": { + "401": { "content": { "application/vnd.api+json": { "schema": { @@ -53177,6 +100837,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -53251,7 +100963,7 @@ } } }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "description": "Unauthorized: the request requires an authentication token.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -53311,72 +101023,8 @@ } } } - } - }, - "summary": "Get a list of active OAuth sessions for the app.", - "tags": [ - "Apps" - ], - "x-snyk-api-releases": [ - "2023-03-30~experimental", - "2023-11-03" - ], - "x-snyk-api-version": "2023-11-03" - }, - "x-snyk-api-resource": "sessions" - }, - "/self/apps/{app_id}/sessions/{session_id}": { - "delete": { - "description": "Revoke an active user app session.", - "operationId": "revokeUserAppSession", - "parameters": [ - { - "$ref": "#/components/parameters/Version" - }, - { - "$ref": "#/components/parameters/AppId" - }, - { - "description": "Session ID", - "in": "path", - "name": "session_id", - "required": true, - "schema": { - "format": "uuid", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The user app sessions has been revoked.", - "headers": { - "deprecation": { - "$ref": "#/components/headers/DeprecationHeader" - }, - "location": { - "schema": { - "type": "string" - } - }, - "snyk-request-id": { - "$ref": "#/components/headers/RequestIdResponseHeader" - }, - "snyk-version-lifecycle-stage": { - "$ref": "#/components/headers/VersionStageResponseHeader" - }, - "snyk-version-requested": { - "$ref": "#/components/headers/VersionRequestedResponseHeader" - }, - "snyk-version-served": { - "$ref": "#/components/headers/VersionServedResponseHeader" - }, - "sunset": { - "$ref": "#/components/headers/SunsetHeader" - } - } }, - "400": { + "403": { "content": { "application/vnd.api+json": { "schema": { @@ -53423,6 +101071,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -53497,7 +101197,7 @@ } } }, - "description": "Bad Request: A parameter provided as a part of the request was invalid.", + "description": "Forbidden: the request requires an authentication token with more or different permissions.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -53558,7 +101258,7 @@ } } }, - "401": { + "404": { "content": { "application/vnd.api+json": { "schema": { @@ -53605,6 +101305,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -53679,7 +101431,7 @@ } } }, - "description": "Unauthorized: the request requires an authentication token or a token with more permissions.", + "description": "Not Found: The resource being operated on could not be found.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -53740,7 +101492,7 @@ } } }, - "403": { + "500": { "content": { "application/vnd.api+json": { "schema": { @@ -53787,6 +101539,58 @@ "format": "uuid", "type": "string" }, + "links": { + "additionalProperties": false, + "description": "A link that leads to further details about this particular occurrance of the problem.", + "example": { + "about": "https://example.com/about_this_error" + }, + "properties": { + "about": { + "example": "https://example.com/api/resource", + "oneOf": [ + { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + { + "additionalProperties": false, + "example": { + "href": "https://example.com/api/resource" + }, + "properties": { + "href": { + "description": "A string containing the link’s URL.", + "example": "https://example.com/api/resource", + "type": "string" + }, + "meta": { + "additionalProperties": true, + "description": "Free-form object that may contain non-standard information.", + "example": { + "key1": "value1", + "key2": { + "sub_key": "sub_value" + }, + "key3": [ + "array_value1", + "array_value2" + ] + }, + "type": "object" + } + }, + "required": [ + "href" + ], + "type": "object" + } + ] + } + }, + "type": "object" + }, "meta": { "additionalProperties": true, "example": { @@ -53861,7 +101665,7 @@ } } }, - "description": "Forbidden: the request requires an authentication token with more or different permissions.", + "description": "Internal Server Error: An error was encountered while attempting to process the request.", "headers": { "deprecation": { "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", @@ -53921,552 +101725,552 @@ } } } + } + }, + "summary": "My User Details", + "tags": [ + "Users" + ], + "x-snyk-api-releases": [ + "2022-03-01~experimental", + "2022-09-14~experimental", + "2024-04-22" + ], + "x-snyk-api-version": "2024-04-22" + }, + "x-snyk-api-resource": "self", + "x-snyk-resource-singleton": true + }, + "/self/apps": { + "get": { + "description": "Get a list of apps that can act on your behalf.", + "operationId": "getUserInstalledApps", + "parameters": [ + { + "$ref": "#/components/parameters/Version" }, - "404": { + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/PublicApp" + }, + "type": "array" + }, "jsonapi": { - "version": "1.0" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, + "required": [ + "data", + "jsonapi", + "links" + ], + "type": "object" + } + } + }, + "description": "A list of apps install that can act on your behalf", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get a list of apps that can act on your behalf.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-version": "2022-03-11" + }, + "x-snyk-api-resource": "user_app_installs" + }, + "/self/apps/installs": { + "get": { + "description": "Get a list of apps installed for an user.", + "operationId": "getAppInstallsForUser", + "parameters": [ + { + "description": "Expand relationships.", + "explode": false, + "in": "query", + "name": "expand", + "schema": { + "items": { + "enum": [ + "app" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.api+json": { + "schema": { + "additionalProperties": false, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/AppInstallData" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ + "data", "jsonapi", - "errors" + "links" ], "type": "object" } } }, - "description": "Not Found: The resource being operated on could not be found.", + "description": "A list of apps installed for the specified organization.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Get a list of apps installed for an user.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-version": "2024-05-23" + }, + "x-snyk-api-resource": "app_installs" + }, + "/self/apps/installs/{install_id}": { + "delete": { + "description": "Revoke access for an app by install ID.", + "operationId": "deleteUserAppInstallById", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/InstallId" + } + ], + "responses": { + "204": { + "description": "The app install has been revoked.", + "headers": { + "deprecation": { + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { + "schema": { + "type": "string" + } + }, + "snyk-request-id": { + "$ref": "#/components/headers/RequestIdResponseHeader" + }, + "snyk-version-lifecycle-stage": { + "$ref": "#/components/headers/VersionStageResponseHeader" + }, + "snyk-version-requested": { + "$ref": "#/components/headers/VersionRequestedResponseHeader" + }, + "snyk-version-served": { + "$ref": "#/components/headers/VersionServedResponseHeader" + }, + "sunset": { + "$ref": "#/components/headers/SunsetHeader" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Revoke access for an app by install ID.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-06-19~experimental", + "2023-11-03", + "2024-05-23" + ], + "x-snyk-api-version": "2024-05-23" + }, + "x-snyk-api-resource": "app_installs" + }, + "/self/apps/{app_id}": { + "delete": { + "description": "Revoke access for an app by app id", + "operationId": "revokeUserInstalledApp", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/AppId" + } + ], + "responses": { + "204": { + "description": "The app has been revoked", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date-time", "type": "string" } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" + } + }, + "summary": "Revoke an app", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2022-03-11" + ], + "x-snyk-api-version": "2022-03-11" + }, + "x-snyk-api-resource": "user_app_installs" + }, + "/self/apps/{app_id}/sessions": { + "get": { + "description": "Get a list of active OAuth sessions for the app.", + "operationId": "getUserAppSessions", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/StartingAfter" + }, + { + "$ref": "#/components/parameters/EndingBefore" + }, + { + "$ref": "#/components/parameters/Limit" + }, + { + "$ref": "#/components/parameters/AppId" + } + ], + "responses": { + "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], + "data": { "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" + "$ref": "#/components/schemas/SessionData" }, - "minItems": 1, "type": "array" }, "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" + "$ref": "#/components/schemas/JsonApi" + }, + "links": { + "$ref": "#/components/schemas/PaginatedLinks" } }, "required": [ - "jsonapi", - "errors" + "data", + "jsonapi" ], "type": "object" } } }, - "description": "Conflict: The requested operation conflicts with the current state of the resource in some way.", + "description": "A list of active OAuth sessions for the app.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/DeprecationHeader" }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, "500": { - "content": { - "application/vnd.api+json": { - "schema": { - "additionalProperties": false, - "example": { - "errors": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "jsonapi": { - "version": "1.0" - } - }, - "properties": { - "errors": { - "example": [ - { - "detail": "Permission denied for this resource", - "status": "403" - } - ], - "items": { - "additionalProperties": false, - "example": { - "detail": "Not Found", - "status": "404" - }, - "properties": { - "code": { - "description": "An application-specific error code, expressed as a string value.", - "example": "entity-not-found", - "type": "string" - }, - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem.", - "example": "The request was missing these required fields: ...", - "type": "string" - }, - "id": { - "description": "A unique identifier for this particular occurrence of the problem.", - "example": "f16c31b5-6129-4571-add8-d589da9be524", - "format": "uuid", - "type": "string" - }, - "meta": { - "additionalProperties": true, - "example": { - "key": "value" - }, - "type": "object" - }, - "source": { - "additionalProperties": false, - "example": { - "pointer": "/data/attributes" - }, - "properties": { - "parameter": { - "description": "A string indicating which URI query parameter caused the error.", - "example": "param1", - "type": "string" - }, - "pointer": { - "description": "A JSON Pointer [RFC6901] to the associated entity in the request document.", - "example": "/data/attributes", - "type": "string" - } - }, - "type": "object" - }, - "status": { - "description": "The HTTP status code applicable to this problem, expressed as a string value.", - "example": "400", - "pattern": "^[45]\\d\\d$", - "type": "string" - }, - "title": { - "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", - "example": "Bad request", - "type": "string" - } - }, - "required": [ - "status", - "detail" - ], - "type": "object" - }, - "minItems": 1, - "type": "array" - }, - "jsonapi": { - "additionalProperties": false, - "example": { - "version": "1.0" - }, - "properties": { - "version": { - "description": "Version of the JSON API specification this server supports.", - "example": "1.0", - "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$", - "type": "string" - } - }, - "required": [ - "version" - ], - "type": "object" - } - }, - "required": [ - "jsonapi", - "errors" - ], - "type": "object" - } - } - }, - "description": "Internal Server Error: An error was encountered while attempting to process the request.", + "$ref": "#/components/responses/500" + } + }, + "summary": "Get a list of active OAuth sessions for the app.", + "tags": [ + "Apps" + ], + "x-snyk-api-releases": [ + "2023-03-30~experimental", + "2023-11-03" + ], + "x-snyk-api-version": "2023-11-03" + }, + "x-snyk-api-resource": "sessions" + }, + "/self/apps/{app_id}/sessions/{session_id}": { + "delete": { + "description": "Revoke an active user app session.", + "operationId": "revokeUserAppSession", + "parameters": [ + { + "$ref": "#/components/parameters/Version" + }, + { + "$ref": "#/components/parameters/AppId" + }, + { + "description": "Session ID", + "in": "path", + "name": "session_id", + "required": true, + "schema": { + "format": "uuid", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The user app sessions has been revoked.", "headers": { "deprecation": { - "description": "A header containing the deprecation date of the underlying endpoint. For more information, please refer to the deprecation header RFC:\nhttps://tools.ietf.org/id/draft-dalal-deprecation-header-01.html\n", - "example": "2021-07-01T00:00:00Z", + "$ref": "#/components/headers/DeprecationHeader" + }, + "location": { "schema": { - "format": "date-time", "type": "string" } }, "snyk-request-id": { - "description": "A header containing a unique id used for tracking this request. If you are reporting an issue to Snyk it's very helpful to provide this ID.\n", - "example": "4b58e274-ec62-4fab-917b-1d2c48d6bdef", - "schema": { - "format": "uuid", - "type": "string" - } + "$ref": "#/components/headers/RequestIdResponseHeader" }, "snyk-version-lifecycle-stage": { - "description": "A header containing the version stage of the endpoint. This stage describes the guarantees snyk provides surrounding stability of the endpoint.\n", - "schema": { - "enum": [ - "wip", - "experimental", - "beta", - "ga", - "deprecated", - "sunset" - ], - "example": "ga", - "type": "string" - } + "$ref": "#/components/headers/VersionStageResponseHeader" }, "snyk-version-requested": { - "description": "A header containing the version of the endpoint requested by the caller.", - "example": "2021-06-04", - "schema": { - "description": "Requested API version", - "pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$", - "type": "string" - } + "$ref": "#/components/headers/VersionRequestedResponseHeader" }, "snyk-version-served": { - "description": "A header containing the version of the endpoint that was served by the API.", - "example": "2021-06-04", - "schema": { - "description": "Resolved API version", - "pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$", - "type": "string" - } + "$ref": "#/components/headers/VersionServedResponseHeader" }, "sunset": { - "description": "A header containing the date of when the underlying endpoint will be removed. This header is only present if the endpoint has been deprecated. Please refer to the RFC for more information:\nhttps://datatracker.ietf.org/doc/html/rfc8594\n", - "example": "2021-08-02T00:00:00Z", - "schema": { - "format": "date-time", - "type": "string" - } + "$ref": "#/components/headers/SunsetHeader" } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "500": { + "$ref": "#/components/responses/500" } }, "summary": "Revoke an active user app session.", @@ -54545,6 +102349,10 @@ "description": "A project is a single external resource which has been scanned by Snyk such as a manifest file or a container image. It may also be continuously monitored by Snyk.\n", "name": "Projects" }, + { + "description": "Snyk pull request templates allow you to control title, description, commit message and branch name.", + "name": "Pull Request Templates" + }, { "description": "A Software Bill of Materials document", "name": "SBOM" @@ -54572,5 +102380,5 @@ ], "x-optic-url": "https://app.useoptic.com/organizations/390ef489-882c-48ba-acb3-4e0b73e48767/apis/5Tz5UMTNEIuz5-FZ6J2ki", "x-snyk-api-lifecycle": "released", - "x-snyk-api-version": "2024-04-29" -} + "x-snyk-api-version": "2024-05-23" +} \ No newline at end of file diff --git a/docs/snyk-api/reference/audit-logs-v1.md b/docs/snyk-api/reference/audit-logs-v1.md index 23ae46669c31..64cc66738c3e 100644 --- a/docs/snyk-api/reference/audit-logs-v1.md +++ b/docs/snyk-api/reference/audit-logs-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - {% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/audit" method="post" %} [spec.yaml](../../.gitbook/assets/spec.yaml) {% endswagger %} diff --git a/docs/snyk-api/reference/dependencies-v1.md b/docs/snyk-api/reference/dependencies-v1.md index 39fa0c65f441..58348ef7604a 100644 --- a/docs/snyk-api/reference/dependencies-v1.md +++ b/docs/snyk-api/reference/dependencies-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - {% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/dependencies" method="post" %} [spec.yaml](../../.gitbook/assets/spec.yaml) {% endswagger %} diff --git a/docs/snyk-api/reference/entitlements-v1.md b/docs/snyk-api/reference/entitlements-v1.md index d799bfc1326f..fe8ffc432b27 100644 --- a/docs/snyk-api/reference/entitlements-v1.md +++ b/docs/snyk-api/reference/entitlements-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - {% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/entitlements" method="get" %} [spec.yaml](../../.gitbook/assets/spec.yaml) {% endswagger %} diff --git a/docs/snyk-api/reference/groups-v1.md b/docs/snyk-api/reference/groups-v1.md index 1e41a9bf9905..bdc6116ce0ae 100644 --- a/docs/snyk-api/reference/groups-v1.md +++ b/docs/snyk-api/reference/groups-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - {% swagger src="../../.gitbook/assets/spec.yaml" path="/group/{groupId}/tags" method="get" %} [spec.yaml](../../.gitbook/assets/spec.yaml) {% endswagger %} diff --git a/docs/snyk-api/reference/import-projects-v1.md b/docs/snyk-api/reference/import-projects-v1.md index 3d13744452ab..84d74b0823d6 100644 --- a/docs/snyk-api/reference/import-projects-v1.md +++ b/docs/snyk-api/reference/import-projects-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - {% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations/{integrationId}/import" method="post" %} [spec.yaml](../../.gitbook/assets/spec.yaml) {% endswagger %} diff --git a/docs/snyk-api/reference/integrations-v1.md b/docs/snyk-api/reference/integrations-v1.md index 0846e79e4ae3..414989f943fd 100644 --- a/docs/snyk-api/reference/integrations-v1.md +++ b/docs/snyk-api/reference/integrations-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - {% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/integrations" method="post" %} [spec.yaml](../../.gitbook/assets/spec.yaml) {% endswagger %} diff --git a/docs/snyk-api/reference/licenses-v1.md b/docs/snyk-api/reference/licenses-v1.md index 655cc4eb2481..501769b8a099 100644 --- a/docs/snyk-api/reference/licenses-v1.md +++ b/docs/snyk-api/reference/licenses-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - **Note:** When you import or update Projects, changes will be reflected in the endpoint results after a one-hour delay. {% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/licenses" method="post" %} diff --git a/docs/snyk-api/reference/monitor-v1.md b/docs/snyk-api/reference/monitor-v1.md index 24268bd07464..10c654cb11ff 100644 --- a/docs/snyk-api/reference/monitor-v1.md +++ b/docs/snyk-api/reference/monitor-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - {% swagger src="../../.gitbook/assets/spec.yaml" path="/monitor/dep-graph" method="post" %} [spec.yaml](../../.gitbook/assets/spec.yaml) {% endswagger %} diff --git a/docs/snyk-api/reference/openapi.md b/docs/snyk-api/reference/openapi.md deleted file mode 100644 index 9932b1537b53..000000000000 --- a/docs/snyk-api/reference/openapi.md +++ /dev/null @@ -1,12 +0,0 @@ -# OpenAPI - -{% hint style="info" %} -This document uses the REST API. For more details, see the [Authentication for API](../authentication-for-api/) page. -{% endhint %} -{% swagger src="../../.gitbook/assets/rest-spec.json" path="/openapi" method="GET" %} -[spec.yaml](../../.gitbook/assets/rest-spec.json) -{% endswagger %} - -{% swagger src="../../.gitbook/assets/rest-spec.json" path="/openapi/{version}" method="GET" %} -[spec.yaml](../../.gitbook/assets/rest-spec.json) -{% endswagger %} diff --git a/docs/snyk-api/reference/organizations-v1.md b/docs/snyk-api/reference/organizations-v1.md index 77ef30a4b1c1..5715581dcbaf 100644 --- a/docs/snyk-api/reference/organizations-v1.md +++ b/docs/snyk-api/reference/organizations-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - {% swagger src="../../.gitbook/assets/spec.yaml" path="/orgs" method="get" %} [spec.yaml](../../.gitbook/assets/spec.yaml) {% endswagger %} diff --git a/docs/snyk-api/reference/projects-v1.md b/docs/snyk-api/reference/projects-v1.md index 0e73e5c6c19a..9bd1990baf98 100644 --- a/docs/snyk-api/reference/projects-v1.md +++ b/docs/snyk-api/reference/projects-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - {% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/project/{projectId}" method="put" %} [spec.yaml](../../.gitbook/assets/spec.yaml) {% endswagger %} diff --git a/docs/snyk-api/reference/pull-request-templates.md b/docs/snyk-api/reference/pull-request-templates.md new file mode 100644 index 000000000000..d1a49ee0a95d --- /dev/null +++ b/docs/snyk-api/reference/pull-request-templates.md @@ -0,0 +1,16 @@ +# Pull Request Templates + +{% hint style="info" %} +This document uses the REST API. For more details, see the [Authentication for API](../authentication-for-api/) page. +{% endhint %} +{% swagger src="../../.gitbook/assets/rest-spec.json" path="/groups/{group_id}/settings/pull_request_template" method="post" %} +[spec.yaml](../../.gitbook/assets/rest-spec.json) +{% endswagger %} + +{% swagger src="../../.gitbook/assets/rest-spec.json" path="/groups/{group_id}/settings/pull_request_template" method="get" %} +[spec.yaml](../../.gitbook/assets/rest-spec.json) +{% endswagger %} + +{% swagger src="../../.gitbook/assets/rest-spec.json" path="/groups/{group_id}/settings/pull_request_template" method="delete" %} +[spec.yaml](../../.gitbook/assets/rest-spec.json) +{% endswagger %} diff --git a/docs/snyk-api/reference/reporting-api-v1.md b/docs/snyk-api/reference/reporting-api-v1.md index 0dbf8e0e9197..81dc5f825910 100644 --- a/docs/snyk-api/reference/reporting-api-v1.md +++ b/docs/snyk-api/reference/reporting-api-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - {% swagger src="../../.gitbook/assets/spec.yaml" path="/reporting/issues/latest" method="post" %} [spec.yaml](../../.gitbook/assets/spec.yaml) {% endswagger %} diff --git a/docs/snyk-api/reference/test-v1.md b/docs/snyk-api/reference/test-v1.md index 9ca02a3fe2e5..6f93c3ce27a6 100644 --- a/docs/snyk-api/reference/test-v1.md +++ b/docs/snyk-api/reference/test-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - {% swagger src="../../.gitbook/assets/spec.yaml" path="/test/yarn" method="post" %} [spec.yaml](../../.gitbook/assets/spec.yaml) {% endswagger %} diff --git a/docs/snyk-api/reference/users-v1.md b/docs/snyk-api/reference/users-v1.md index cb685f330a1a..1dcb712d6fbd 100644 --- a/docs/snyk-api/reference/users-v1.md +++ b/docs/snyk-api/reference/users-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - {% swagger src="../../.gitbook/assets/spec.yaml" path="/user/{userId}" method="get" %} [spec.yaml](../../.gitbook/assets/spec.yaml) {% endswagger %} diff --git a/docs/snyk-api/reference/webhooks-v1.md b/docs/snyk-api/reference/webhooks-v1.md index 7d1b4fcb0ba5..eab462b286f0 100644 --- a/docs/snyk-api/reference/webhooks-v1.md +++ b/docs/snyk-api/reference/webhooks-v1.md @@ -3,7 +3,6 @@ {% hint style="info" %} This document uses the v1 API. For more details, see the [v1 API](../v1-api-overview/). {% endhint %} - {% swagger src="../../.gitbook/assets/spec.yaml" path="/org/{orgId}/webhooks" method="post" %} [spec.yaml](../../.gitbook/assets/spec.yaml) {% endswagger %}